我要投搞

标签云

收藏小站

爱尚经典语录、名言、句子、散文、日志、唯美图片

当前位置:香港赛马会 > 多行注释 >

编程中的注释分为三类 单行注释多行文档;

归档日期:06-11       文本归类:多行注释      文章编辑:爱尚语录

  可选中1个或多个下面的关键词,搜索相关资料。也可直接点“搜索资料”搜索整个问题。

  2009-05-10展开全部晕~~~ 自己还是找到了 ·· 留给后来人吧···

  1 注释文档的格式注释文档将用来生成HTML格式的代告,所以注释文档必须书写在类、域、构造函数、方法、定义之前。注释文档由两部分组成——描述、块标记。

  文件头注释以 /*开始,以*/结束,需要注明该文件创建时间,文件名,命名空间信息。

  类、接口的注释采用 /** … */,描述部分用来书写该类的作用或者相关信息,块标记部分必须注明作者和版本。

  构造函数注释采用 /** … */,描述部分注明构造函数的作用,不一定有块标记部分。

  域注释可以出现在注释文档里面,也可以不出现在注释文档里面。用/** … */的域注释将会被认为是注释文档热出现在最终生成的HTML报告里面,而使用/* … */的注释会被忽略。

  /* 由于triger和表用一个DMSource,所以要区分和表的迁移成功标记 */

  /** 由于triger和表用一个DMSource,所以要区分和表的迁移成功标记 */

  方法注释采用 /** … */,描述部分注明方法的功能,块标记部分注明方法的参数,返回值,异常等信息。例如:

  @param后面空格后跟着参数的变量名字(不是类型),空格后跟着对该参数的描述。

  在描述中第一个名字为该变量的数据类型,表示数据类型的名次前面可以有一个冠词如:a,an,the。如果是int类型的参数则不需要注明数据类型。例如:

  对于参数的描述是一个句子,最好不要首字母大写,如果出现了句号这说明你的描述不止一句话。如果非要首字母大写的话,必须用句号来结束句子。(英文的句号)

本文链接:http://wsfcsmagnets.net/duoxingzhushi/595.html