如何在c#中记录方法参数?存在类似Javadoc的东西

本文关键字：存在 Javadoc 参数 方法 记录 | 更新日期: 2023-09-27 17:49:51

我是c#的新手(我来自Java)

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

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

在c#中记录这些东西的约定是什么?

如何在c#中记录方法参数?存在类似Javadoc的东西

是的，看看XML文档。

MSDN上有一个关于它的页面- http://msdn.microsoft.com/en-us/library/z04awywx.aspx

你可以使用"<>"标签。

来自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

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

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

你可以写你的评论。

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

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

/// <summary> 
/// A function summary here.
/// </summary>
/// <param name="inParam">An in parameter</param>
相关文章：