.net方法参数注释编写实例

原帖地址：http://blog.csdn.net/kgdiwss/archive/2006/11/30/1422388.aspx

主要是example,code标记等的运用,怕忘了,所以记录一下.
[align=left][/align]
[align=left] #region GetLatestJobInfo[/align]
[align=left] ///<summary>[/align]
[align=left] ///获取最新的职位信息[/align]
[align=left] ///</summary>[/align]
[align=left] ///<example> [/align]
[align=left] ///<code>[/align]
[align=left] ///<font face="宋体" size="2">[/align]
[align=left] /// [C#][/align]
[align=left] /// public class MyClass[/align]
[align=left] /// {[/align]
[align=left] /// public void myMethod()[/align]
[align=left] /// {[/align]
[align=left] /// <font color="green">//创建web service对象</font>[/align]
[align=left] /// wsJobPosition position = new wsJobPosition();[/align]
[align=left] /// [/align]
[align=left] /// <font color="green">//获取最新条信息</font>[/align]
[align=left] /// <font color="green">//前一个参数表示获取的记录条数,后一个参数表示排序字段,""表示按dtCreate降序</font>[/align]
[align=left] /// DataSet ds = position.GetLatestJobInfo(10, ""); [/align]
[align=left] /// [/align]
[align=left] /// <font color="green">//其它代码</font>[/align]
[align=left] /// }[/align]
[align=left] /// }[/align]
[align=left] /// [/align]
[align=left] ///</font> [/align]
[align=left] ///</code>[/align]
[align=left] ///</example>[/align]
[align=left] ///<param name="topNumber">显示最新条数</param>[/align]
[align=left] ///<param name="orderField">降序排列的字段,默认为dtCreate</param>[/align]
[align=left] ///<returns>返回某字段降序排列的前N条记录</returns>[/align]
[align=left] [WebMethod] [/align]
[align=left] public DataSet GetLatestJobInfo(int topNumber, string orderField)[/align]
[align=left] {[/align]
[align=left] DataSet ds = new DataSet();[/align]
[align=left] DataTable dt; [/align]
[align=left] [/align]
[align=left] orderField = orderField == "" ? "dtCreate" : orderField;[/align]
[align=left] [/align]
[align=left] string sql = "SELECT TOP {0} * FROM Job_Position order by {1} desc";[/align]
[align=left] sql = string.Format(sql, topNumber, orderField);[/align]
[align=left] [/align]
[align=left] dt = clsFactory.Create().GetDataTable(sql);[/align]
[align=left] ds.Tables.Add(dt); [/align]
[align=left] [/align]
[align=left] return ds;[/align]
[align=left] }[/align]
#endregion

用NDoc生成的说明如下:
获取最新的职位信息

public DataSet GetLatestJobInfo(
int topNumber,
string orderField
);

参数
topNumber
显示最新条数
orderField
降序排列的字段,默认为dtCreate

返回值
返回某字段降序排列的前N条记录

示例

[C#]
public class MyClass
{
public void myMethod()
{
//创建web service对象
wsJobPosition position = new wsJobPosition();

//获取最新10条信息
//前一个参数表示获取的记录条数,后一个参数表示排序字段,""表示按dtCreate降序
DataSet ds = position.GetLatestJobInfo(10, "");

//其它代码
}
}