有没有办法在IDE中将两个注释链接在一起？

Question

案例：一个源文件中有一条注释，它直接链接到另一个源文件中的注释（有关更多信息，请参阅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将在使用其重构工具（例如重命名类或方法）时自动更新这些。如果手动完成更改，Eclipse仍会警告@link的目标无效。 （在某些情况下，还有@see更合适。）

我不确定C＃和Visual Studio，但它的基于XML的doc格式很可能提供类似的功能。

Answer 2

你可以试试这个插件（我还没有用过）：

http://hyperaddin.codeplex.com/

除了这个插件，我唯一能想到的是使用文件链接直接转到链接文件;类似的东西：

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

该链接将转换为您可以使用Ctrl+Left Click点击的实际链接，但它不会将您带到指定的行号 - 它只会打开文件。

路径可以是相对文件路径或完整文件路径 - 如果所有团队成员在项目中使用相同的文件夹结构，则完整路径最有效。例如：

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

Answer 3

处理此问题的唯一方法是将注释放在同一个文件中。复制注释与复制代码不同，尽管理想情况下代码在注释中不需要太多解释。

为什么评论在另一个文件中会导致痛苦有很多很多原因。正如你所说的那样，行号可能会改变，但也可以删除（因为他们不会知道另一个注释引用它），以改变其含义的方式更新，在任何情况下都必须打开另一个文件很烦人