1 / 12
文档名称:

软件开发项目开发规范.pdf

格式:pdf   大小:668KB   页数:12页
下载后只包含 1 个 PDF 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

软件开发项目开发规范.pdf

上传人:小屁孩 2022/8/15 文件大小:668 KB

下载得到文件列表

软件开发项目开发规范.pdf

相关文档

文档介绍

文档介绍:: .
软件开发项⽬开发规范
JAVA语⾔编程Name()
setSarry()
isLogon()
⽅法参数建议顺序:(被操作者,操作内容,操作标志,其他?)
例:public void replace(String sourceStr, String oldStr, String newStr) {
........
}
常量
采⽤完整的英⽂⼤写单词,在词与词之间⽤下划线连接,如:DEFAULT_VALUE
变量和参数
采⽤直接定义的⽅法,要做到清晰易懂的原则,如:
实体类例如:Project project;直接把类型的⾸个⼤写字母变成⼩写字母就⾏了。
⽇期型例如:Date createDate;
组件/部件
应采⽤完整的英⽂描述符命名组件(接⼝部件),遵循匈⽛利命名法则
如:btnOK,lblName。
btn+Xxxxxxx 例如:btnSave,btnExit,btnPrint等
lbl+Xxxxxxxx 例如:lblName,lblSex 等
C.
对象类型前缀
Canvas cvs
CheckBox chk
Image img
List listChoice chc
Dialog dlg
Event evt
Frame frm
Menu menu
Panel pnl
TextArea txa
TextField txf
集合
采⽤变量+集合类型的⽅法⼀个集合定义,如果集合采⽤泛型的话就必须泛型化处理如:
Array userArray = new Array(); //⽤户列表
Map userMap = new Map();//⽤户Map
List onLineUserList = new List< User >();//在线⽤户List
神秘的数
程序⾥经常会⽤到⼀些量,它是有特定的含义的,把神秘的数定义为⼀个常量。注意这个常量的命名应该能表达该数的意义,
并且应该全部⼤写,以与对应于变量的标识符区别开来。例如50这个数,可以定义为⼀个名为NUM_OF_EMPLOYEES的常
量来代替。
其他
命名时应使⽤复数来表⽰它们代表多值。如:orderItems。
Java异常
异常类名由表⽰该异常类型的单词和Exception组成,如ActionException。
异常实例⼀般使⽤e、ex等,在多个异常时使⽤该异常名或简写加E,Ex等组成,如:SQLEx;ActionEx
数组命名
数组应该总是⽤下⾯的⽅式来命名:
byte[] buffer;
⽽不是
byte buffer[];
4. 书写格式规范
严格要求书写格式是为了使程序整齐美观、易于阅读、风格统⼀,程序员对规范书写的必要性要有明确认识。建议源程序使⽤
eclipse⼯具开发,格式规范预先在⼯具中设置。
缩进
缩进建议以4个空格为单位。预处理语句、全局数据、标题、附加说明、函数说明、标号等均顶格书写。语句块的"{"、"}"配对
对齐,并与其前⼀⾏对齐,语句块类的语句缩进建议每个"{"、"}"单独占⼀⾏,便于匹对。Mysclipse 中的默认⽅式是开始的"
{"不是单独⼀⾏,建议更改成上述格式。
空格
原则上变量、类、常量数据和函数在其类型,修饰名称之间适当空格并据情况对齐。关键字原则上空⼀格,如:if ( ... )等。运
算符的空格规定如下:"::"、"->"、"["、"]"、"++"、"--"、"~"、"!"、"+"、"-"(指正负号)、"&"(引⽤)等⼏个运算符两边不加
空格(其中单⽬运算符系指与操作数相连的⼀边),其它运算符(包括⼤多数⼆⽬运算符和三⽬运算符"?:"两边均加⼀空格,
在作函数定义时还可据情况多空或不空格来对齐,但在函数实现时可以不⽤。","运算符只在其后空⼀格,需对齐时也可不空或多空格。不论是否有括号,对语句⾏后加的注释应⽤适当空格与语句隔开并尽可能对齐。个⼈认为此项可以依照个****惯决定
遵循与否。
对齐
原则上关系