程序员开发手册 java 项目文档

《 安 全 生 产 信 息 化 管 理 系 统 》

程序员开发手册

1 概述

目的

、方便代码的交流和维护。

、不影响编码的效率，不与大众习惯冲突。

、使代码更美观、阅读更方便。

、使代码的逻辑更清晰、更易于理解。

负责人视具体情况做出相关处理。

术语定义

、匈牙利命名法【禁用】

标识符的名字以一个或者多个小写字母开头作为前缀；前缀之后的是首字母大写的一个

单词或多个单词组合，该单词要指明变量的用途。

例如：数组定义以小写字母  开头

、帕斯卡（）命名法【推荐】

将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的

标识符使用  大小写。例如：

、骆驼命名法【推荐】

如： !"#$%&

、'() 语句拼接、字符串拼接、函数参数名过长、判断语句过长的代码要遵循以上

原则。

换行

、当表达式超出或即将超出规定的列宽，一行被分为几行时，通过将串联运算符放

在每一行的末尾而不是开头，清楚地表示没有后面的行是不完整的。

' *+%'%$,'-)-./01,/. 01,234/0

、每一行上放置的语句避免超过一条。

、当表达式超出或即将超出规定的列宽，遵循以下规则进行换行

在逗号前换行。

（）在操作符前换行。

77&

7234/7&

当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。

缩进

缩进应该是每行一个 .8 个空格，不要在代码中使用 .8 字符。

设置：工具9:选项9:文本编辑器9:;9:制表符9:插入空格

空行

空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。

在以下情况下使用两个空行

、接口和类的定义之间。

、枚举和类的定义之间。

、类与类的定义之间。

在以下情况下使用一个空行

>、注释与它注释的语句间不空行，但与其他的语句间空一行。

空格

在以下情况中要使用到空格

、关键字和左括符“0应该用空格隔开。如

6? 

注意;在方法名和左括符“0之间不要使用空格，这样有助于辨认代码中的方法调用与关

键字。多个参数用逗号隔开，每个逗号后都应加一个空格。

、除了@之外，所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、11

及99与操作数间不需要空格。如

、以下写法是不允许的：

括号-()

、左括号“0不要紧靠关键字，中间用一个空格隔开。

、左括号“0与方法名之间不要添加任何空格。

、没有必要的话不要在返回语句中使用。如