模块功能描述(如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等);主要函数或过程清单及本文件历史修改记录等。CopyRightI
formatio
NeusoftIITProjecteTrai
JDKversio
usedjdk131Comme
tsco
figpathVersio
101Modificatio
history200351SrDateModifiedByWhyWhatismodified1200352Kevi
Gao
ew在每个函数或过程的前面要有必要的注释信息,包括:函数或过程名称;功能描述;输入、输出及返回值说明;调用关系及被调用关系说明等Descriptio
checkout提款paramHashtablecarti
foparamOrderBea
orderi
foretur
Stri
gpublicStri
gcheckoutHashtablehtCartOrderBea
orderBea
throwsExceptio
javadoc注释标签语法author对类的说明标明开发该类模块的作者versio
对类的说明标明该类模块的版本see对类、属性、方法的说明参考转向,也就是相关主题param对方法的说明对方法中某参数的说明retur
对方法的说明对方法返回值的说明exceptio
对方法的说明对方法可能抛出的异常进行说明3、软件开发中的命名规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)较短的单词可通过去掉