JAVA程序设计 第八章编程规范和JAVADoc

纲要：

1、编程规范：规范的编程习惯有助于程序的理解和维护。

       a、命名规范：包的命名一般采用域名逆序，名称全部小写；文件的名称与public类同名；类与接口的命名名词词组每个单词首字母大写其余小写，要求使用全称用词准确简单；方法的命名动词词组只有中间单词首字母大写。字段的命名名词词组中间单词首字母大写其余小写，从数据功能出发，简练准确；常量命名字母全部大写中间使用下划线；

       b、编辑规范：tab一般禁止使用，因为不同的OS有不同的长度解释；一般文件不要超过2000行，每行不超过80个字符；推荐采用四空格缩排方式；分行要考虑逻辑关系；类和类之间两个空白行；方法之间插一个空白行；方法和字段定义之间插一个空白行；局部变量和第一个语句间插一个空白行；方法中的逻辑块插一个空白行(基本上只有类和类间插两个空白行，类的内部也是按逻辑只差一个空白行，在方法体内按逻辑分块，每块间只插一个空白行)；

       c、注释：总体介绍功能，详细介绍约束条件，避免对简单语句解释；文件组织：一般按如下顺序：注释，package，import，类或接口的定义；文件的注释一般包括：类的名字作者版权日期版本及文件本省描述；类和接口的定义：类和接口的文档注释/** */;优先定义public 然后protected最后是private域。方法定义：每个方法前都要有文档注释/**<detailed desc>   *@param <> *@return <> *@excetpion<> *@author<>*/

2、JAVADoc: javadoc是从程序提取文档注释/**  */生成HTML帮助文件的工具。

     格式/** description

               *@tag

               */

     常用tag标签有@author @return @param@throws @see @version @since @link @deprecated

     使用方法：javadoc -d  .   -author   Time2.java