软件开发编码标准

《软件开发编码标准》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、资源共享系统编码（Java）标准书　Version01.00一、Java编码标准（一）目的本标准是为了确保编码统一的保守性，定义Java源代码编码方法的标准。（二）源文件的构成1、行数对于源文件，2000行（不含comment）为基准，超过这个的情况下，就要讨论调整等级/界面设计。2、同级内定义的顺序A)一个源文件只定义一个等级/界面，禁止使用内部级。同级内定义的顺序如下。①package定义package名全部小写package名要取有意义的名字②输入定义在输入文中禁止使用星号"*"。「java.lang」package是不输入的

2、资源共享系统编码（Java）标准书　Version01.00①级定义②常数定义③级变数/实例变数定义④Constructor定义⑤Method定义常数、变数、Constructor、Method均按可视性（public,protected,private）由高到低记载。A)界面定义的顺序界面定义的顺序如下。①package定义②输入文在输入文中禁止使用星号"*"。「java.lang」package是不输入的③输入定义能力附加型的界面名在末尾要加上“able”④变数定义⑤（抽象）Method定义（三）CommentComment分为

3、文本Comment和实装Comment。资源共享系统编码（Java）标准书　Version01.001、文本Comment文本Comment:利用javadoc命令，记载为了生成HTML的API依据的级・界面和字段・Method等处理说明。A)级・界面・列举型，记载以下内容①级名称（行末尾加上英文句号"."）系统名称、业务机能名称②业务名称（种类的话记载种类代码，画面ID单位的话记载画面名，帐票ID单位的话记载帐票名等）③类别***WEB层的情况***--ActionForm→ActionForm--Action→Action--A

4、ctionLogic→ActionLogic--Command→Command--checker级等→业务Bean--编号数据保持级→编号--ActionForm以外的数据保持级→Parameter或Model***EJB层的情况***资源共享系统编码（Java）标准书　Version01.00--JustwareApl→JustwareApl--Service→Service--Factory,Logic,其他业务级→业务Bean***其他***--例外级→Exception①级式样概略（写成1行，末尾加上英文句号"."）②版本信

5、息（@version）③参考文件（@see）（有参考文件的话记载文件名，不过，是任意的）④作成者（@author）⑤导入的版本信息（@since）/***

*级名称:统一目录管理.*子系统名称:统一目录查询*业务名称:*类别:业务Bean*取得事故信息.*

6、码（Java）标准书　Version01.00A)Constructor①　Constructor的文本Comment记载下述内容。a、处理概要/***DOI特定的情况下，将唯一标识符设定成实例变数。*@paramdoi契约号码*/publicTestClass(Stringdoi){this.doi=doi;}b、参数（参数名说明）B)Method①Method的文本Comment记载下述内容。(a)处理概要（写成1行，末尾加句号"。"或英文句号"."。）(b)处理详细（最后一行加句号"。"或英文句号"."。）(c)参数（参数名说

7、明）(d)返回值（说明）(e)Method内可能会被throw的除外（完全指定例外处理级名说明）/***

*～　记载Method的概要　～。*～　记载Method的详细　～。*

8、ckComment”“1行Comment”“行末Comment”。B)BlockComment①BlockComment使用于多行Comment的记载，记载数据构造和算法等。②因调试等暂时把逻辑Comment化的情况下，也会使用。③记