源代码编写规范
版本10
ff1简介411目的412范围4
2代码格式规范43代码注释规范54命名规范95异常处理规范116其他规范11
f1简介
11目的
本文用于定义本公司程序编码规范。本文的目的在于规范和指导软件编程活动,作为考核标准。
12范围
本文仅用于指导软件编程工作,同时作为其他分析和设计工作的参考资料。本文的预期读者是:软件工程师设计员、程序员。
本公司各项目可以采用不同的编程语言,并参照本规范和各语言的习惯定义各自的编程规范,但是必须经过评审通过。编程规范一旦通过评审,任何人在编程活动中都必须遵循。
2代码格式规范
【规范1】单行代码不得超过120字符。【规范2】每行代码最多包含一个独立的语句。【规范3】代码缩进两个空格。说明:两个空格已经足够清晰了,缩进量过大会导致单行代码很长,反而影响阅读。【规范4】不要使用TAB缩进代替空格缩进。【规范5】如果单行代码过长,则应该遵循以下规则断行:
在逗号的后面。在操作符的前面。断行的起始位置应该对其原行表达式的起始位置,如果无法满足,则缩进2个空格。
【规范6】每一个变量的声明独占一行。【规范7】将变量的声明置于代码块的开始位置。【规范8】在java中for、while、dowhile循环,if、elseif、else、switchcase分支,trycatchfi
ally块即使仅包含一个语句,也要用包含。其他语言参照执行。【规范9】空行的位置:
在逻辑代码段之间。for、while、dowhile循环,if、elseif、else、switchcase分支,trycatchfi
ally块的前面。在两个类或接口的定义之间。在两个方法函数过程之间。方法函数过程内部变量定义行和第一个非变r