为什么人们写:“ /// <method> /// 一些方法描述 /// </method>”,这种注释风格从何而来?
Why do people write: " /// <method> /// Some method description /// </method>", where did this style of commenting came from?
/// <method>
/// Open Database Connection if Closed or Broken
/// </method>
public void MyMethod () {...}
我刚开始学习 C#,这种评论风格我见过很多次。谁能告诉我人们以这种方式发表评论是否有原因,这种评论方式从何而来?
这些是 XML Documentation Comments,可以被 C# 编译器 /doc 选项和 Sandcastle 等工具用来自动生成 API 文档。
/// <method>
/// Open Database Connection if Closed or Broken
/// </method>
public void MyMethod () {...}
我刚开始学习 C#,这种评论风格我见过很多次。谁能告诉我人们以这种方式发表评论是否有原因,这种评论方式从何而来?
这些是 XML Documentation Comments,可以被 C# 编译器 /doc 选项和 Sandcastle 等工具用来自动生成 API 文档。