visual-studio - IDEで2つのコメントをリンクする方法はありますか？

Question

ケース：1つのソースファイルに、別のソースファイルのコメントに直接リンクされているコメントが含まれています（詳細については、xxx.csの315行目を参照してください）。このアプローチの問題は、315行目のコメントが将来その行番号にない可能性があることです。IDEでコメントをリンクする方法はありますか？（現在はVisual Studio 2010を使用していますが、他のIDEを使用することもあります）

Answer 1

特定のソースファイルと行番号を参照することは決して良い考えではありません。誰かが他のファイルを指していることに気付かずに、他のファイル内で物事を移動する可能性があるからです。たとえば、特定のタイプ/メソッドを指定することをお勧めしSee DoThings() in the MyThing class.ます。

Javaでは、Javadocを使用@linkして、これを行うことができます。たとえば、See {@link MyThing#doThings()}。Eclipseは、リファクタリングツールを使用するときにこれらを自動的に更新します（たとえば、クラスまたはメソッドの名前を変更します）。@link変更が手動で行われた場合でも、Eclipseはのターゲットが無効であることを警告します。（@see状況によっては、より適切なものもあります。）

C＃とVisual Studioについてはよくわかりませんが、XMLベースのドキュメント形式で同様の機能が提供されている可能性があります。

Answer 2

このアドインを試すことができます（私はこれを使用していません）：

http://hyperaddin.codeplex.com/

このアドインの他に、私が考えることができるのは、ファイルリンクを使用してリンクされたファイルに直接移動することだけです。何かのようなもの：

// ...
// See file://path_to_file
//...

リンクは、クリックして使用できる実際のリンクに変換されますCtrl+Left Clickが、特定の行番号に移動することはありません。ファイルを開くだけです。

パスは、相対ファイルパスまたはフルファイルパスにすることができます。フルパスは、すべてのチームメンバーがプロジェクトで同じフォルダー構造を使用する場合に最適に機能します。例えば：

// file://w:/projects/GUI/frmMain.cs

Answer 3

これを処理する唯一の方法は、コメントを同じファイルに入れることです。コメントを複製することは、コードを複製することと同じではありませんが、理想的には、コードはコメントであまり多くの説明を必要としないでしょう。

コメントが別のファイルにあると苦痛を引き起こす理由はたくさんあります。あなたが述べたように、行番号は変更される可能性がありますが、削除される可能性もあり（別のコメントがそれを参照していることを知らないため）、その意味を変更する方法で更新され、いずれにせよ別のファイルを開かなければならないのは面倒です。