Question

我正在完成一些我的第一个C＃类，即使我继承的原始代码完全没有注释，我总是在编写java时将javadoc注释放在我的方法上，而且我的代码目前看起来很奇怪而没有这些块

我通常使用Eclipse中的“插入JavaDoc”命令来格式化我的注释，该命令只是简单地布置模板并从运行命令的方法中提取参数，方法名称等。然后我可以从那里添加更多细节。

Visual Studio 2008中是否有类似的命令？当我在菜单上戳时，我找不到一个。另外，在C＃世界中是否有标准的注释风格（类似于JavaDoc）？

Answer 1

如果您键入///，IDE编辑器将自动为您生成空的XML注释。

此：

///
public QName(String qName, XmlNode contextNode) {

成为这个：

/// <summary>
/// 
/// </summary>
/// <param name="qName"></param>
/// <param name="contextNode"></param>
public QName(String qName, XmlNode contextNode) {

如果您的方法抛出任何异常，则必须手动添加标记，因为.NET没有声明的异常。最后评论：

/// <summary>Creates a new QName from a string with the format
/// <c>prefix:local-name</c> or <c>local-name</c>.</summary>
/// 
/// <param name="qName">A QName string.</param>
/// <param name="contextNode">An XML node from which to lookup the namespace
/// prefix, or <c>null</c>.</param>
/// 
/// <exception cref="XmlInvalidPrefixException">Thrown if the prefix cannot be
/// resolved from the lookup node. If <paramref name="contextNode"/> is
/// <c>null</c>, then the only prefix that can be resolved is <c>xml</c>.
/// </exception>
public QName(String qName, XmlNode contextNode) {

Answer 2

在任何方法之前键入三个正斜杠：

///

这将生成一个XML注释块。

Answer 3

如果在Visual Studio中的方法之前键入三个正斜杠“///”，它将自动创建一个简单的模板供您注释方法。（它会为你创建字段来评论参数和返回值。）我认为这很好，因为它快速而简单，但你可能想要更深入的东西。

Answer 4

在C＃中，如果在要注释的内容上输入三个斜杠，它将自动为目标插入相应的文本。

它将包括摘要，参数（如果有），返回（如果有的话）等。

///

然后，您可以使用NDoc之类的内容来获取这些评论并从中构建API文档。

Answer 5

Visual Studio的免费加载项GhostDoc将帮助您创建C＃XML文档的基本结构，提供比///更多的内容可以帮助您从Visual Studio本身获取。

Answer 6

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

整个功能称为xml-doc，您可以google许多示例。

评论样式（即Javadocing C＃版本） - （Java Developer Learning C＃）

6 个答案: