• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

代码规范之C#注释

原作者: [db:作者] 来自: [db:来源] 收藏 邀请

注释:(摘抄,自己学习用)    了解一本书---> .Net设计规范

在C#中,程序注释有三种。

 

关于程序注释需要理解的是:注释是给阅读程序的人看的,不是给编译器或操作系统执行指令功能的,没有这个作用。

 

 三种注释:

 

1. //单行注释;

 

 

 

2. /*

 

  多行或一段注释

 

  */

 

 

 

3. ///<summary>

 

  ///这是对类的说明

 

  ///</summary>

 

 

 

  ///<summary>

 

  ///这是对方法的说明

 

  ///</summary>

 

  ///<param  name=“args”></param>

 

 

 

指示代码折叠指令

 

  #region  这是第一段代码

 

  code

 

  ........

 

  #endregion

 

注释语法

 

       为了使用C#提供的XML注释功能,你的注释应该使用特殊的注释语法(///)开头。在///之后,你可以使用预先定义的标签注释你的代码,也可以插入你自己定义的标签。你定制的标签将会在随后加入到生成的注释文档中。

 

预定义的标签              用处

<c>                             将说明中的文本标记为代码

<code>                       提供了一种将多行指示为代码的方法

<example>                  指定使用方法或其他库成员的示例

<exception>            允许你指定可能发生的异常类

<include>                    允许你引用描述源代码中类型和成员的另一文件中的注释使用 XML                       XPath 语法来描述你的源代码中的类型和成员。

<list>                           XML注释文档中插入一个列表

<para>                        XML注释文档中插入一个段落

<param>                     描述一个参数

<paramref>                 提供了一种指示一个词为参数的方法

<permission>              允许你将成员的访问许可加入到文档中

<remarks>                  用于添加有关某个类型的信息

<returns>                    描述返回值

<see>                         指定链接

<seealso>                   指定希望在请参见一节中出现的文本

<summary>                 类型或类型成员的通用描述

<value>                       描述属性

 


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
上一篇:
C++说明符和限定符发布时间:2022-07-13
下一篇:
c++与java的几个不同点发布时间:2022-07-13
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap