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

导读：
　　
　　主要是example,code标记等的运用,怕忘了,所以记录一下.
　　#regionGetLatestJobInfo
　　///

　　///获取最新的职位信息
　　///

　　///
　　///
　　///
　　///[C#]
　　///public class MyClass
　　///{
　　/// public void myMethod()
　　/// {
　　/// //创建web service对象
　　/// wsJobPosition position = new wsJobPosition();
　　///
　　/// //获取最新条信息
　　/// //前一个参数表示获取的记录条数,后一个参数表示排序字段,""表示按dtCreate降序
　　/// DataSet ds = position.GetLatestJobInfo(10, "");
　　///
　　/// //其它代码
　　/// }
　　/// }
　　///
　　///
　　///
　　///
　　///显示最新条数
　　///降序排列的字段,默认为dtCreate
　　///返回某字段降序排列的前N条记录
　　[WebMethod]
　　publicDataSet GetLatestJobInfo(inttopNumber, stringorderField)
　　{
　　DataSet ds = newDataSet();
　　DataTable dt;
　　
　　orderField = orderField == ""? "dtCreate": orderField;
　　
　　stringsql = "SELECT TOP {0} * FROM Job_Position order by {1} desc"
　　sql = string.Format(sql, topNumber, orderField);
　　
　　dt = clsFactory.Create().GetDataTable(sql);
　　ds.Tables.Add(dt);
　　
　　returnds;
　　}
　　#endregion
　　bbs.bitsCN.com
　　用NDoc生成的说明如下:
　　获取最新的职位信息 BBS.bitsCN.com网管论坛
　　public DataSet GetLatestJobInfo(
　　int topNumber,
　　string orderField
　　); bbs.bitsCN.com
　　参数
　　topNumber
　　显示最新条数
　　orderField
　　降序排列的字段,默认为dtCreate bitsCN.nET*中国网管博客
　　返回值
　　返回某字段降序排列的前N条记录
　　bbs.bitsCN.com中国网管论坛
　　示例 DL@bitsCN_com网管软件下载
　　[C#]
　　public class MyClass
　　{
　　public void myMethod()
　　{
　　//创建web service对象
　　wsJobPosition position = new wsJobPosition();
　　www_bitscn_com中国.网管联盟
　　//获取最新10条信息
　　//前一个参数表示获取的记录条数,后一个参数表示排序字段,""表示按dtCreate降序
　　DataSet ds = position.GetLatestJobInfo(10, "");
　　
　　//其它代码
　　}
　　}-

本文转自
http://www.bitscn.com/dotnet/framework/200709/109655.html