评论样式(即Javadocing C#版本) - (Java Developer Learning C#)

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) {