.net方法参数注释编写实例
来源:互联网 发布:淘宝卖家评论在哪里 编辑:程序博客网 时间:2024/05/01 13:57
原帖地址:http://blog.csdn.net/kgdiwss/archive/2006/11/30/1422388.aspx
主要是example,code标记等的运用,怕忘了,所以记录一下.
主要是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, "");
//其它代码
}
}
- .net方法参数注释编写实例[原创]
- .net方法参数注释编写实例
- .net方法参数注释编写实例
- .net方法参数注释编写实例
- .net方法参数注释编写实例
- .net方法参数注释编写实例
- .net方法参数注释编写实例(转)
- 类注释文档编写方法
- 类注释文档编写方法
- 类注释文档编写方法
- java类注释文档编写方法
- Java 类注释文档编写方法
- 可变参数宏编写方法
- 可变参数宏编写方法
- 一个excel+SQL方法实例详细注释
- [Java]获取java方法注释实例
- C# 委托参数方法实例
- asp.net前台页面调用后台带参数的方法实例
- 删除确认操作 c#
- 信念最重要
- 从Excel导入到Access
- java 词汇表速查手册(附:J2EE相关名次解释)
- javascript
- .net方法参数注释编写实例
- cxGrid 最佳列宽
- 深圳、香港、新加坡 我的程序轨迹
- 软件版本号命名规则详解
- HGE中文显示最新修改 - 070717
- 内核模块编译入门
- Weblogic在AIX下的安装和调试
- 社区网站黏合逐渐走弱 媒体吸引成为未来制胜
- Nvidia手册