分享
 
 
 

.net方法参数注释编写实例[原创]

王朝c#·作者佚名  2007-07-18
窄屏简体版  字體: |||超大  

主要是example,code标记等的运用,怕忘了,所以记录一下.

#region GetLatestJobInfo

///<summary>

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

///</summary>

///<example>

///<code>

///<font face=">宋体" size="2">

/// [C#]

/// public class MyClass

/// {

/// public void myMethod()

/// {

/// <font color="green">//创建web service对象</font>

/// wsJobPosition position = new wsJobPosition();

///

/// <font color="green">//获取最新条信息</font>

/// <font color="green">//前一个参数表示获取的记录条数,后一个参数表示排序字段,""表示按dtCreate降序</font>

/// DataSet ds = position.GetLatestJobInfo(10, "");

///

/// <font color="green">//其它代码</font>

/// }

/// }

///

///</font>

///</code>

///</example>

///<param name="topNumber">显示最新条数</param>

///<param name="orderField">降序排列的字段,默认为dtCreate</param>

///<returns>返回某字段降序排列的前N条记录</returns>

[WebMethod]

public DataSet GetLatestJobInfo(int topNumber, string orderField)

{

DataSet ds = new DataSet();

DataTable dt;

orderField = orderField == "" ? "dtCreate" : orderField;

string sql = "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);

return ds;

}

#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, "");

//其它代码

}

}

 
 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
2023年上半年GDP全球前十五强
 百态   2023-10-24
美众议院议长启动对拜登的弹劾调查
 百态   2023-09-13
上海、济南、武汉等多地出现不明坠落物
 探索   2023-09-06
印度或要将国名改为“巴拉特”
 百态   2023-09-06
男子为女友送行,买票不登机被捕
 百态   2023-08-20
手机地震预警功能怎么开?
 干货   2023-08-06
女子4年卖2套房花700多万做美容:不但没变美脸,面部还出现变形
 百态   2023-08-04
住户一楼被水淹 还冲来8头猪
 百态   2023-07-31
女子体内爬出大量瓜子状活虫
 百态   2023-07-25
地球连续35年收到神秘规律性信号,网友:不要回答!
 探索   2023-07-21
全球镓价格本周大涨27%
 探索   2023-07-09
钱都流向了那些不缺钱的人,苦都留给了能吃苦的人
 探索   2023-07-02
倩女手游刀客魅者强控制(强混乱强眩晕强睡眠)和对应控制抗性的关系
 百态   2020-08-20
美国5月9日最新疫情:美国确诊人数突破131万
 百态   2020-05-09
荷兰政府宣布将集体辞职
 干货   2020-04-30
倩女幽魂手游师徒任务情义春秋猜成语答案逍遥观:鹏程万里
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案神机营:射石饮羽
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案昆仑山:拔刀相助
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案天工阁:鬼斧神工
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案丝路古道:单枪匹马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:与虎谋皮
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:李代桃僵
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:指鹿为马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:小鸟依人
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:千金买邻
 干货   2019-11-12
 
推荐阅读
 
 
 
>>返回首頁<<
 
靜靜地坐在廢墟上,四周的荒凉一望無際,忽然覺得,淒涼也很美
© 2005- 王朝網路 版權所有