Question

添加对注释的引用已有详细记录，适用于Visual Studio中项目之间的链接。

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

    /// text for Main
    static void Main()
    {
    }
}

但是如何让它在一般评论中发挥作用？你可能在命名空间之上有注释块，或者在一般代码中你需要其他程序员看到的不仅仅是代码。当我尝试以下操作时，Visual Studio对它没有什么特别之处，不像它在///中并且在类或方法之前。

/*
  First Line to Comment. Maybe a Copyright
  Second Line to Comment
  Third Line to Comment
  Some other junk where users should look at <seealso cref="TestClass.Main"/>    
*/

Answer 1

这仅适用于doc-comments，也称为///引入的XML注释。

如果在项目选项中设置了相应的选项，则C＃可以从这些注释中创建XML文件。 Sandcastle Help File Builder或NDoc等外部工具可以使用XML文件中的信息以及从程序集反映的信息来创建帮助文件。

这些引用将插入生成的帮助文件中。它们在普通的注释中没有多大意义，因为它们被C＃编译器忽略了。

但 Sandcastle帮助文件生成器和 NDoc 允许您将项目摘要和命名空间摘要注释添加到生成的帮助文件中。

Answer 2

我认为这个想法是你没有。

三个正斜杠注释被定义为XML文档标记，它们可以由VS解析并转换为Web文档。

但是一般的双斜线和多线评论完全被忽略了。

如何在c＃中添加对一般注释的引用？

2 个答案: