黑马程序员技术交流社区

标题: “第二贴”之注释和帮助文档制作(注解在高新那块整理) [打印本页]

作者: 曹睿翔    时间: 2013-5-3 00:04
标题: “第二贴”之注释和帮助文档制作(注解在高新那块整理)
本帖最后由 曹睿翔 于 2013-5-3 00:09 编辑

声明是用了搬运大法,前人栽树后人乘凉
注解:
一、背景
      1、当我们第一次接触某段代码,但又被要求在极短的时间内有效地分析这段代码,我们需要什么样的注释信息?
      2、怎么样避免我们的注释冗长而且凌乱不堪呢?
      3、在多人协同开发、维护的今天,我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢?
二、意义
     程序中的注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件本身和软件开发人员而言尤为重要。并且在流行的敏捷开发思想中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护。好的注释规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码。好的注释规范可以最大限度的提高团队开发的合作效率。长期的规范性编码还可以让开发人员养成良好的编码习惯,甚至锻炼出更加严谨的思维能力。
三、注释的原则
      1        注释形式统一
          在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其他项目组发现他们的注释规范与这份文档不同,按照他们的规范写代码,不要试图在既成的规范系统中引入新的规范。
      2        注释的简洁
内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。
      3        注释的一致性
          在写代码之前或者边写代码边写注释,因为以后很可能没有时间来这样做。另外,如果有机会复查已编写的代码,在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建,解释性注释在开发过程中创建,提示性注释在代码完成之后创建。修改代码的同时修改相应的注释,以保证代码与注释的同步。
      4        注释的位置
          保证注释与其描述的代码相邻,即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置,不可放在下方。避免在代码行的末尾添加注释;行尾注释使代码更难阅读。不过在批注变量声明时,行尾注释是合适的;在这种情况下,将所有行尾注释要对齐。
      5        注释的数量
          注释必不可少,但也不应过多,在实际的代码规范中,要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”,而不是文档,程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱,注释的花样要少。不要被动的为写注释而写注释。
      6、删除无用注释
          在代码交付或部署发布之前,必须删掉临时的或无关的注释,以避免在日后的维护工作中产生混乱。
      7        复杂的注释
          如果需要用注释来解释复杂的代码,请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码,而应该重写它。尽管一般不应该为了使代码更简单便于使用而牺牲性能,但必须保持性能和可维护性之间的平衡。
      8        多余的注释
          描述程序功能和程序各组成部分相互关系的高级注释是最有用的,而逐行解释程序如何工作的低级注释则不利于读、写和修改,是不必要的,也是难以维护的。避免每行代码都使用注释。如果代码本来就是清楚、一目了然的则不加注释,避免多余的或不适当的注释出现。
      9、必加的注释
          典型算法必须有注释。在代码不明晰或不可移植处必须有注释。在代码修改处加上修改标识的注释。在循环和逻辑分支组成的代码中添加注释。为了防止问题反复出现,对错误修复和解决方法的代码使用注释,尤其是在团队环境中。
      10、注释在编译代码时会被忽略,不编译到最后的可执行文件中,所以注释不 会增加可执行文件的大小。


作者: 曹睿翔    时间: 2013-5-3 00:04
四、JAVA注释技巧
1、空行和空白字符也是一种特殊注释。利用缩进和空行,使代码与注释容易区
别,并协调美观。
2、当代码比较长,特别是有多重嵌套时,为了使层次清晰,应当在一些段落的
结束处加注释(在闭合的右花括号后注释该闭合所对应的起点),注释不能
写得很长,只要能表示是哪个控制语句控制范围的结束即可,这样便于阅读。
3、将注释与注释分隔符用一个空格分开,在没有颜色提示的情况下查看注释时,
这样做会使注释很明显且容易被找到。
4、不允许给块注释的周围加上外框。这样看起来可能很漂亮,但是难于维护。
5、每行注释(连同代码)不要超过120个字(1024×768),最好不要超过80
(800×600)
6Java编辑器(IDE)注释快捷方式。Ctrl+/ 注释当前行,再按则取消注释。
7、对于多行代码的注释,尽量不采用“/*......*/”,而采用多行“//”注释,
这样虽然麻烦,但是在做屏蔽调试时不用查找配对的“/*......*/”。
8、注释作为代码切换开关,用于临时测试屏蔽某些代码。
例一:
//*/
   codeSegement1;
//*/
改动第一行就成了:
/*/
   codeSegement1;
//*/
例二:
//----------------------第一段有效,第二段被注释
//*/
   codeSegement1;
/*/
   codeSegement2;
//*/
只需删除第一行的/就可以变成:
//----------------------第一段被注释,第二段有效
/*/
   codeSegement1;
/*/
   codeSegement2;
//*/
五、JAVA注释方法及格式
1、单行(single-line)--短注释://……   
单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。
注释格式:/* 注释内容 */
行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。
注释格式:// 注释内容
   
行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。
注释格式:代码 + 8(至少4)个空格 + // 注释内容
2、块(block)--块注释:/*……*/
注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成:
/*
  * 注释内容
  */
3、文档注释:/**……*/
注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符
/**......*/之中,注释文档将用来生成HTML格式的代码报告,所以注释文
档必须书写在类、域、构造函数、方法,以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。注释文档的格式如下:
/**
* The doGet method of the servlet.
* This method is called when a form has its tag value method
   * equals to get.
* @param request
*  the request send by the client to the server
* @param response
*  the response send by the server to the client
* @throws ServletException
*  if an error occurred
* @throws IOException
*  if an error occurred
*/
public void doGet (HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
    doPost(request, response);
}
前两行为描述,描述完毕后,由@符号起头为块标记注释。更多有关文档注
释和javadoc的详细资料,参见javadoc的主页: http://java.sun.com/javadoc/index.html
4javadoc注释标签语法
@author    对类的说明 标明开发该类模块的作者
@version   对类的说明 标明该类模块的版本
@see      对类、属性、方法的说明 参考转向,也就是相关主题
@param    对方法的说明 对方法中某参数的说明
@return    对方法的说明 对方法返回值的说明
@exception  对方法的说明 对方法可能抛出的异常进行说明

作者: 曹睿翔    时间: 2013-5-3 00:04
六、JAVA注释具体实现
1、源文件注释
源文件注释采用 /** …… */,在每个源文件的头部要有必要的注释信息,包括:文件名;文件编号;版本号;作者;创建时间;文件描述包括本文件历史修改记录等。中文注释模版:
/**
* 文 件 名 :
    * CopyRright (c) 2008-xxxx:
* 文件编号:
* 创 建 人:
* 日    期:
* 修 改 人:
* 日   期:
* 描   述:
* 版 本 号:
*/

2、类(模块)注释:
类(模块)注释采用 /** …… */,在每个类(模块)的头部要有必要的注释信息,包括:工程名;类(模块)编号;命名空间;类可以运行的JDK版本;版本号;作者;创建时间;类(模块)功能描述(如功能、主要算法、内部各部分之间的关系、该类与其类的关系等,必要时还要有一些如特别的软硬件要求等说明);主要函数或过程清单及本类(模块)历史修改记录等。
英文注释模版:
/**
* CopyRright (c)2008-xxxx:   <展望软件Forsoft >                          
    * Project:                     <项目工程名 >                                          
* Module ID:   <(模块)类编号,可以引用系统设计中的类编号>   
    * Comments:  <对此类的描述,可以引用系统设计中的描述>                                          
* JDK version used:      <JDK1.6>                              
* Namespace:           <命名空间>                              
* Author:        <作者中文名或拼音缩写>                 
* Create Date:  <创建日期,格式:YYYY-MM-DD>
* Modified By:   <修改人中文名或拼音缩写>                                         
* Modified Date:  <修改日期,格式:YYYY-MM-DD>                                    
    * Why & What is modified  <修改原因描述>   
* Version:                  <版本号>                       
*/
如果模块只进行部分少量代码的修改时,则每次修改须添加以下注释:
//Rewriter
//Rewrite Date:<修改日期:格式YYYY-MM-DD> Start1:
/* 原代码内容*/
//End1:
将原代码内容注释掉,然后添加新代码使用以下注释:
//Added by
//Add date:<添加日期,格式:YYYY-MM-DD> Start2:
//End2:
如果模块输入输出参数或功能结构有较大修改,则每次修改必须添加以下
注释:
//Log ID:<Log编号,从1开始一次增加>
//Depiction:<对此修改的描述>
//Writer:修改者中文名
//Rewrite Date:<模块修改日期,格式:YYYY-MM-DD>

2、接口注释:
接口注释采用 /** …… */,在满足类注释的基础之上,接口注释应该包含描述接口的目的、它应如何被使用以及如何不被使用,块标记部分必须注明作者和版本。在接口注释清楚的前提下对应的实现类可以不加注释。

3、构造函数注释:
构造函数注释采用 /** …… */,描述部分注明构造函数的作用,不一定有块标记部分。
注释模版一:
/**
* 默认构造函数
*/
注释模版二:
/**
* Description :       带参数构造函数,
*                       初始化模式名,名称和数据源类型
* @param schema:   模式名
* @param name:   名称
* @param type: 数据源类型
*/

4、函数注释:
函数注释采用 /** ……*/,在每个函数或者过程的前面要有必要的注释信息,包括:函数或过程名称;功能描述;输入、输出及返回值说明;调用关系及被调用关系说明等。函数注释里面可以不出现版本号(@version)。
注释模版一:
/**
  * 函 数 名 :
  * 功能描述:
* 输入参数:     <按照参数定义顺序>
*             <@param后面空格后跟着参数的变量名字
*            (不是类型),空格后跟着对该参数的描述。>
*
* 返 回 值:  - 类型 <说明>
*            <返回为空(void)的构造函数或者函数,
*            @return可以省略; 如果返回值就是输入参数,必须 *            用与输入参数的@param相同的描述信息; 必要的时*            候注明特殊条件写的返回值。>
* 异    常:<按照异常名字的字母顺序>
* 创 建 人:
* 日    期:
* 修 改 人:
* 日    期:
*/
注释模版二:
/**
* FunName:           getFirstSpell
  * Description :      获取汉字拼音首字母的字符串,
*                   被生成百家姓函数调用
  * @param:         str the String是包含汉字的字符串
  * @return String:汉字返回拼音首字母字符串;
*                  英文字母返回对应的大写字母;
*                 其他非简体汉字返回 '0';
* @Author:       ghc
* @Create Date: 2008-07-02
*/

5、方法注释:
方法注释采用 /** …… */,对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建时间必须注释清楚,为将来的维护和阅读提供宝贵线索。

6、方法内部注释:
控制结构,代码做了些什么以及为什么这样做,处理顺序等,特别是复杂的逻辑处理部分,要尽可能的给出详细的注释。
   
7、        全局变量注释:
要有较详细的注释,包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事项等的说明。

8、局部(中间)变量注释:
主要变量必须有注释,无特别意义的情况下可以不加注释。

9、实参/参数注释:
参数含义、及其它任何约束或前提条件。

10、字段/属性注释: 字段描述,属性说明。

11、常量:常量通常具有一定的实际意义,要定义相应说明。

作者: 曹睿翔    时间: 2013-5-3 00:04
javadoc的命令行语法如下:

javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ]

参数可以按照任意顺序排列。下面分别就这些参数和相关的一些内容进行说明:

Packagenames 包列表。这个选项可以是一系列的包名(用空格隔开),例如java.lang java.lang.reflect
java.awt。不过,因为javadoc不递归作用于子包,不允许对包名使用通配符;所以你必须显示地列出希望建立文档的每一个包。

Sourcefiles 源文件列表。这个选项可以是一系列的源文件名(用空格隔开),可以使用通配符。javadoc允许四种源文件:类源代码文件、包描述文件、总体概述文件、其他杂文件。

◇ 类源代码文件:类或者接口的源代码文件。

◇ 包描述文件:每一个包都可以有自己的包描述文件。包描述文件的名称必须是"package.html",与包的.java文件放置在一起。包描述文件的内容通常是使用HTML标记写的文档。javadoc执行时将自动寻找包描述文件。如果找到,javadoc将首先对描述文件中<body></body>之间的内容进行处理,然后把处理结果放到该包的Package
Summary页面中,最后把包描述文件的第一句(紧靠<body>)放到输出的Overview summary页面中,并在语句前面加上该包的包名。

◇ 总体概述文件:javadoc可以创建一个总体概述文件描述整个应用或者所有包。总体概述文件可以被任意命名,也可以放置到任意位置。-overview选项可以指示总体概述文件的路径和名称。总体概述文件的内容是使用HTML标记写的文档。javadoc在执行的时候,如果发现-overview选项,那么它将首先对文件中<body></body>之间的内容进行处理;然后把处理后的结果放到输出的Overview
summary 页面的底部;最后把总体概述文件中的第一句放到输出的Overview summary页面的顶部。

◇ 其他杂文件:这些文件通常是指与javadoc输出的HTML文件相关的一些图片文件、Java源代码文件(.java)、Java程序(.class)、Java小程序(Applets)、HTML文件。这些文件必须放在doc-files目录中。每一个包都可以有自己的doc-files目录。举个例子,你希望在java.awt.Button的HTML文档中使用一幅按钮的图片(Button.gif)。首先,你必须把图片文件放到C:\user\src\java\awt\doc-files\中;然后在Button.java文件中加入下面注释

/**

* This button looks like this:

* <img src="doc-files/Button.gif">

*/

@files 包含文件。为了简化javadoc命令,你可以把需要建立文档的文件名和包名放在一个或多个文本文件中。例如,为了简化下面命令:

javadoc -d apidoc com.mypackage1 com.mypackage2 com.mypackage3

你可以建立一个名称为mypackage.txt的文件,其内容如下:

com.mypackage1

com.mypackage2

com.mypackage3

然后执行下面命令即可:

javadoc -d apidoc @mypackage.txt

options 命令行选项。javadoc使用doclets(doclets是指用doclet API编写的程序。)来确定输出的内容和格式。命令行选项中一部分是可用于所有doclet的通用选项,一部分是由默认的标准doclet提供的专用的选项。下面对各自一些常用的选项分别进行介绍:

通用选项:

◇ -1.1 生成具有javadoc 1.1版本生成的文档的外观和功能的文档。不是所有的选项都可以用于-1.1选项,具体可以使用javadoc
-1.1 -help察看。

◇ -help 显示联机帮助。

◇ -bootclasspath classpathlist 指定"根类"(通常是Java平台自带的一些类。例如java.awt.*等)的路径。

◇ -sourcepath sourcepathlist 指定包的源文件搜索路径。但是必须注意,只有在javadoc命令中指定了包名的时候才可以使用-sourcepath选项。如果指定了包名,而省略了-sourcepath,那么javadoc使用类路径查找源文件。举例说明:假定你打算为com.mypackage建立文档,其源文件的位置是C:\user\src。那么你可以使用下面的命令:

javadoc -sourcepath c:\user\src com.mypackage

◇ -classpath classpathlist 指定javadoc查找"引用类"的路径。引用类是指带文档的类加上它们引用的任何类。javadoc将搜索指定路径的所有子目录。Classpathlist可以包含多个路径(使用;隔开)。如果省略-classpath,则javadoc使用-sourcepath查找源文件和类文件。举例说明:假定你打算为com.mypackage建立文档,其源文件的位置是C:\user\src,包依赖C:\user\lib中的库。那么你可以使用下面的命令:

javadoc -classpath c:\user\lib -sourcepath c:\user\src com.mypackage

◇ -overview path\filename 告诉javadoc从path\filename所指定的文件中获取概述文档,并且把它放到输出的概述页面(overview-summary.html)中。其中path\filename是相对于-sourcepath的相对路径。

◇ -public 只显示公共类以及成员。

◇ -protected 只显示受保护的和公共的类以及成员。缺省选项。

◇ -package只显示包、受保护的和公共的类以及成员。

◇ -private 显示所有类和成员。

◇ -doclet class 指定javadoc产生输出内容的自定义doclet类。如果忽略这个选项,javadoc将使用默认的doclet产生一系列HTML文档。

◇ -docletpath classpathlist 与- doclet选项相关,制定自定义的doclet类文件的路径。Classpathlist可以包含多条路径(用;隔开)。

◇ -verbose 在javadoc运行时提供更详细的信息。

标准doclet专用选项:

◇ -author 在生成的文档中包含"作者"项。

◇ - d directory 指定javadoc保存生成的HTML文件的目录。省略该选项将把文件保存在当前目录。Directory可以是绝对目录,也可以是相对当前目录的相对目录。

◇ -version 在生成的文档中包含"版本"项。

◇ -use 为类和包生成"use"(用法)页面。这些页面描述了该类和包在javadoc命令涉及的文件中被使用的情况。例如:对于给定的类C,在C的用法页面中将包含C的子类,类型为C的域,返回变量类型为C的方法以及在参数中有变量类型为C的方法和构造器。

◇ -splitindex 把索引文件按照字母顺序分为多个文件。每一个文件对应一个字母。

◇ -windowtitle title 指定输出的HTML文档的标题。

◇ -header header 指定输出的HTML文档的页眉文本。

◇ -footer footer 指定输出的HTML文档的脚注文本。

◇ -bottom text 指定输出的HTML文档底部的文本。

◇ - group groupheading packagepatten;packagepatten;… 在总体概述页面中按照命令的指定方式分隔各个包。例如执行下面命令:

javadoc -group "Core Packages" "java.lang*:java.util"

-group "Extension Packages" "javax.*"

java.lang java.lang.reflect java.util javax.servlet java.new

在页面中将有如下结果:

Core Packages

java.lang

java.lang.reflect

java.util

Extension Packages

javax.servlet

Other Packages

java.new

◇ - noindex 不输出索引文件。

◇ - help 在文件的导航条中忽略help链接。

◇ - helpfile path\filename 指定导航条中的help链接所指向的帮助文件。忽略该选项,javadoc将生成缺省的帮助文件。

◇ -stylesheetfile path\filename 指定javadoc的HTML样式表文件的路径。忽略该选项,javadoc将自动产生一个样式表文件stylesheet.css。



作者: 曹睿翔    时间: 2013-5-3 00:04
通过上面的介绍,我们了解了javadoc的命令行语法,下面开始介绍javadoc文档注释方法。

javadoc注释以"/**"开始,以"*/"结束,里面可以包含普通文本、HTML标记和javadoc标记。javadoc只处理源文件中在类/接口定义、方法、域、构造器之前的注释,忽略位于其他地方的注释。举例如下:
/**

*我的第一个程序--<b>Helloworld</b>

*@author 王鸿

*@version 1.0 2001/10/15

*/

public class myHelloworld

{

/**

*在main( )方法中使用的显示用字符串

*@see #main(java.lang.String[])

*/

static String SDisp

使用下面命令:

javadoc -private -d doc -author -version myHelloworld.java

即可以生成漂亮的关于myHelloworld.java的API文档了。

上面例子中以@开头的标记就是javadoc标记。在Java程序中正确使用javadoc标记是一个良好的注释习惯,将非常有助于javadoc自动从源代码文件生成完整的格式化API文档。下面就对各种标记进行详细说明。

◇ @author name-text 指定生成文档中的"作者"项,从JDK/SDK 1.0开始引入。name-text可以指定多个名字(使用","隔开)。文档注释可以包含多个类。

◇ {@docroot} 代表产生文档的根路径,从JDK/SDK 1.3开始引入。用法举例如下

/**

*see the <a href={@docroot}/copyright.html>copyright</a>

*/

假定生成文档的根目录是doc,上面注释所在的文件最后生成的文件是doc\utility\utl.html,那么"copyright"的链接会指向..\copyright.html。

◇ @deprecated deprecated-text 添加注释,表明不推荐使用该API。

◇ @exception class-name description @throw的同义标记,从JDK/SDK 1.0开始引入。

◇ {@link package.class#member label} 插入指向package.class#member的内嵌链接,从JDK/SDK
1.2开始引入。举例说明,假定注释中有如下文档:

/** Use the {@link #getComponentAt(int, int) getComponentAt} method. */

那么javadoc最终生成的HTML页面中将有如下内容

Use the <a href = "Component.html#getComponentAt(int,int)"
> getComponentAt </a> method.

◇ @param parameter-name description 描述参数,从JDK/SDK 1.0开始引入。

◇ @return description 描述返回值,从JDK/SDK 1.0开始引入。

◇ @see reference 添加"参见"标题,其中有指向reference的链接或者文本项,从JDK/SDK
1.0开始引入。@see标记有三种形式,下面分别说明:

(1)、@see "string" 为"string"添加文本项,不产生链接。

(2)、@see <a href="URL#Value">Label</a> 使用HTML标记产生链接

(3)、@see packag
作者: 曹睿翔    时间: 2013-5-3 00:05
明早来整理
作者: admin    时间: 2013-5-3 00:06
注释吧,猛一看还以为是java的注解技术
作者: 曹睿翔    时间: 2013-5-3 00:07
admin 发表于 2013-5-3 00:06
注释吧,猛一看还以为是java的注解技术

对对,等整理到张老师的高新的时候再加注解技术
我改下标题
作者: 曹睿翔    时间: 2013-5-3 00:31
明天还需要精简,这样看着不行




欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/) 黑马程序员IT技术论坛 X3.2