Question

我是C＃的新手（我来自Java）

在Java中，我经常使用javadoc注释我的方法来记录参数类型和返回值

像

这样的东西

/* @param an int
   @param a Rectangle object
   @return void
*/
   public void myMethod(int i, Rectangle rec){
      .............
      .............
   }

在C＃中记录这些内容的惯例是什么？

Answer 1

是的，请查看XML文档。

在MSDN上有一个不错的页面 - http://msdn.microsoft.com/en-us/library/z04awywx.aspx

Answer 2

您可以使用＆＃34;＆lt;摘要＆gt;＆＃34;标签

来自MSDN的示例：

/// <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>

http://msdn.microsoft.com/en-us/library/2d6dt3kf.aspx

Answer 3

默认情况下，visual studio有三条反斜杠用于评论。当你把它放在一个函数上面时它会显示

    /// <summary>
    /// 
    /// </summary>

您可以在其中撰写评论。

如果你想要一些先进的东西，请从visualstudiogallery获得Ghostdoc。这是一个免费的工具。

Answer 4

只需在方法，类，字段等之前插入三个///并编写您想要的内容，您甚至可以添加示例，异常等。一个例子：

/// <summary> 
/// A function summary here.
/// </summary>
/// <param name="inParam">An in parameter</param>

如何在C＃中记录方法参数？存在像Javadoc这样的东西？

4 个答案: