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

来源：作者：出处：综艺读书 2007-07-23

关键词：os ie

·为.NET程序批上WPF的绚丽外衣
·VS.NET无缝集成Crystal Reports
·网友推荐：.Net分页控件发布
·基于VC.NET的GDI+编程之CImage
·C#.NET 中的类型转换
·微软 .NET Remoting体系结构评估
·利用.NET绘图技术制作水晶按钮控件
·.NET 开发人员该下载的十个必备工具
·提供一个.NET平台通用串口操作类
·编程必备 C#.NET 中的类型转换

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

#region GetLatestJobInfo

///<summary>

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

///</summary>

///<example>

///<code>

///宋体" size="2">

/// [C#]

/// public class MyClass

/// {

/// public void myMethod()

/// {

/// //创建web service对象

/// wsJobPosition position = new wsJobPosition();

///

/// //获取最新条信息

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

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

///

/// //其它代码

/// }

///

///

///</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移动与嵌入式技术专题，或进入讨论组讨论。

【收藏此文】【大中小】【打印】【关闭】

较早的文章：字符串的驻留（String Interning）

较新的文章：

站内各频道最新更新文档

Google CEO个人安全一年53万

Photoshop调节反转负冲效果

·托管服务市场：服务需求大
·同方服务器让你的网吧更红
·金蝶K3让利百货业绩翻翻
·东软证券数据系统解决方案
·金融系统广域网解决方案
·IBM：金融市场策略解决方案
·证券行业交易平台解决方案
·三星人寿保险Sybase案例

·东软商业保险系统解决方案
·CSO向Sun平台应用移植解决..
·东软税务全面整体解决方案
·珠海国地税KILL安全系统案例
·友讯：D-Link助昆明市公安..
·江苏邮政票据打印机系统方案
·浪潮：云南国税备份系统案例
·CSS 标签属性

站内最新制作专题

·win98频道
·Windows XP频道
·Windows Vista频道
·Windows 2000频道
·win2003频道
·Freebsd频道
·Oracle频道
·安全频道

·Linux频道
·Windows频道
·邮件服务器专题
·协议大全
·数据恢复指南教程
·FreeBSD使用教程
·Linux数据库宝典
·Linux基础知识

热门关键字导读

站内频道文章精选

新闻资讯	电脑技巧
· 秘密:Vista隐蔽的动态屏保 · 腾讯开发新电子宠物--QQ熊 · 惠普否认2999元PC有价无货	· 驱逐Win系统“流氓”文件 · WinXP中获取未使用的IP地址 · 尝试format C:格式化硬盘？
操作系统	常用软件
· 在DOS下恢复回收站中的文件 · 拯救WinXP崩溃的救命稻草 · Linux系统中超级权限的应用	· 搜狗PK谷歌：谁能代言拼... · 昨日重现，一键GHOST轻松.. · 实现Web迅雷在空闲时杀毒
桌面开发	网络编程
· AVIFile函数制做AVI文件 · VC中链接动态链接库的方法 · 熊猫烧香核心源码(Delphi)	· DateDiff函数祥解 · JavaScript去除空格的三种 · js效果图片加载进度实时..
数据库	图像处理
· SQL Server数据库优化方案 · Oracle的初学者入门心得 · JSP连接Mysql数据库	· Photoshop为美女做艺术处理 · 用Freehand创建发光字特效 · 设计自己的个性QQ动态表情

百度推荐，商机无限

搜索您感兴趣的内容