全球旧事资料 分类
2构件内的每个过程或方法应该有注释。包括:功能描述、参数说明、返回值说明、最后更新作者如果有改动、最后更新日期如果有改动323每个模块级变量、重要的变量必须给出注释,使用“”单行注释。
33使用JavaDoc辅助生成统一的注释:
为规范、方便生成统一的程序文档,应在代码注释中遵循JavaDoc的注释规范(建议在开发工具中输入“回车”,填入所有自动弹出项。)
331构件约定注释与JavaDoc中对应:
模块名称:功能描述:作者:版本:
SeeTodoAuthorVersio

f
对系统规范化的异常处理。包含各种异常编码,标准出错提示与日志的产生和管理。

异常类型ID
149:系统内部异常-标准处理:写日志,向客户端抛出CustomExceptio
异常
5099:用户界面异常-标准处理:写日志,向客户端抛出对应的自定义异常
100以上:扩展异常

注意:写日志时应使用getSysMsg获得对应的异常日志记录串;向用户端抛出的

异常则在getUserMsg中携带应在界面上显示的信息串

si
ce20011218
authorliju

versio
10


332过程和方法约定注释与JavaDoc中对应:
功能描述:参数说明:返回值说明:最后更新作者:最后更新日期:
MethodComme
tsParameterComme
tsRetur
s如有改动,自己添加如有改动,自己添加
初始化方法,在这里初始化所有用户公用的变量,这里简单地将工作交给父类处理。paramco
figServletCo
fig对象,包含Servlet初始化的参数。throwsServletExceptio
初始化可能产生ServletExceptio
异常。retur

4命名
41一般概念命名时应始终采用完整的英文描述符。此外,一般应采用小写字母,但类名、接口名以及任何非初始单词的第一个字母要大写。尽量使用完整的英文描述符,采用适用于该领域的术语采用大小写混合使名字可读尽量少用缩写,但如果用了,要明智地使用。避免使用长的名字(小于15个字母是个好主意)避免使用类似的名字,或者仅仅是大小写不同的名字
作为补充,在一个项目中需要有相关的术语表(Glossary)对命名进行规范,特别是在使用拼音缩写时,需要有术语表的定义。
f42类型标识符(TypeTag)
说明:类型标识符(TypeTag)由一个字母序列组成;类型标识符经过约定唯一标识一种数据类型。包括以下各种约定:
数据类型
类型标识符
byteshorti
tlo
gcharfloatdoubleboolea
Stri
gjavautilDatejavasqlDatejavasqlTimestampjavautilVectorjavautilListJavautilMapArraysoforigi
altype
ByteShortilchfdbsdttsvlstmpaorigi
altypetag
为逐一直接列出的请参照下面的r
好听全球资料 返回顶部