Question

C# 完整XML注释 示例

/// <summary>
/// 提取学员基本信息
/// </summary>
///<param name="p">参数</param>
/// <returns>学员基本信息</returns>
我还想在其中加入 这个方法是谁添加，何时添加的注释，怎么加？

Answer 1

如果在方法中添加这样的注释是不规范的，你可以在类上添加注释：如图

Answer 2

/// <summary>
/// 提取学员基本信息
/// </summary>
///<param name="p">参数</param>
/// <returns>学员基本信息</returns>
/// <AddBy>添加人</AddBy>
/// <AddDate>添加人</AddDate>
/// <summary>
这个很简单的
节点随你个人定义

Answer 3

/// <summary>
/// 提取学员基本信息
/// </summary>
///<param name="p">参数</param>
/// <returns>学员基本信息</returns>
足够了,其它的信息有点多余了,
<summary>这个标签可以让以后的维护或再开发人员在IDE看到看到这个方法的描术,再加上<param name="p"><returns>这两个标足够清楚了

Answer 4

微软推荐的标签有下边这些：
<c>
<para>
<see>
<code>
<param>
<seealso>
<example>
<paramref>
<summary>
<exception>
<permission>
<value>
<include>
<remarks>
<list>
<returns>

除了这些以外，开发人员可自由创建自己的标记集。
你可以用 <author>来表示 方法的添加者。<date>表示添加的时间 等等。。。

Answer 5

二楼的,LZ这样的注释是可以再调用的时候看到信息的
包括注释和参数注释,和系统的方法一样