2

案例：一个源文件中有一个注释，该注释直接链接到另一个源文件中的注释（有关详细信息，请参见 xxx.cs 中的第 315 行）。这种方法的问题在于，第 315 行的注释将来可能不在该行号处。有没有办法在 IDE 中将评论链接在一起？（目前使用 Visual Studio 2010，但不时使用其他 IDE）

4

3 回答 3

1

引用一个特定的源文件和行号从来都不是一个好主意，因为有人可能会在另一个文件中移动东西而不知道有什么东西指向它。最好指出特定的类型/方法，例如See DoThings() in the MyThing class..

在 Java 中，您可以使用 Javadoc@link来执行此操作，例如See {@link MyThing#doThings()}. Eclipse 将在使用其重构工具（例如重命名类或方法）时自动更新这些内容。如果更改是手动完成的，Eclipse 仍然会警告目标@link无效。（@see在某些情况下也有更合适的。）

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

于 2012-11-12T20:54:29.740 回答
1

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

http://hyperaddin.codeplex.com/

除了这个插件，我唯一能想到的就是使用文件链接直接进入链接文件；就像是：

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

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

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

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

于 2012-11-12T20:56:33.733 回答
0

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

注释在另一个文件中会引起痛苦的原因有很多。正如您所说，行号可能会更改，但也可能会被删除（因为他们不会知道其他评论引用它），以改变其含义的方式进行更新，并且无论如何都必须打开另一个文件很烦人.

于 2012-11-12T20:52:47.837 回答