计算机源代码编写规范
文件编号:
NW506104
生效日期:
2000320
受控编号:
密级:秘密
版次:Ver21
修改状态:
总页数
6
正文
6
附录
0
编制:马云生
审核:袁淮
批准:孟莉
沈阳东阿尔派软件股份限公司
(版权翻版必究)
文件修改控制
修改记录编号
修改
状态
修改页码条款
修改
审核
批准
修改日期
目录
1 目
2 适范围
3 术语缩略语
4 规范容
41 标识符命名书写规范
42 注释规
43 缩进规
1 目
良编程风格提高程序性非常重手段型项目合作开发技术基础规范目通规范定义避免编程风格增强程序易读性便程序员理解
2 适范围
规定适软件源程序编写客户特殊求时遵循客户提出求移植性开发低版升级开发前版格式求
3 术语缩略语
程序采NQ402100质量手册中术语缩略语定义
4 规范容
41 标识符命名书写规
411 基规
1) 里标识符指编程语言中语法象名字常量名变量名函数名类类型名文件名等标识符基语法字母开始字母数字划线组成单词
2) 标识符身够表明身含义便阅读应中含义词组成英文词中文拼音词
3) 标识符词组成时词第字母写余全部写常量标识符全部写中文词中文描述含义汉字头拼音字母组成英文词量缩写果缩写系统中单词必须相表示法
4) 标识总长度超32字符
412 特殊约定
编程工具项目开发组标识符命名规定例标识符分两部分:
规范标识前缀+含义标识
1) 规范标识前缀标明该标识类特征便类型标识互相区例:字符串变量标识符前缀str某字符串变量命名:strExample文框象标识符前缀txt某文框象命名:txtExample
2) 含义标识标明该标识应抽象实体便记忆面例子中strExampleExample含义标识编程工具项目开发组特殊约定约定准
41 3 源代码文件标识符命名规
源代码文件标识符分两部分文件名前缀缀格式规:
×××……×××××
1) 前缀部分通常该文件表示容作关项目组成员统约定
2) 缀部分通常表示该文件类型定具体编程环境特殊规定编程环境规定准
3) 前缀缀两部分字符应仅字母数字划线文件标识长度超32字符便识
42 注释格式求
注释总加程序需概括性说明易理解易理解错方注释应语言简炼易懂准确采语种首选中文输入困难编译环境限制特殊需求采英文
421 源代码文件注释
1) 文件头部必须标明程序名称完成功
2) 文件作者完成时间
3) 阶段测试结束修改活动修改时间简单原说明列表
4) 维护程中需修改程序时应修改语句前面注明修改时间原说明
422 函数程注释
1) 函数头部必须函数进行功参数(值参变参)说明
2) 函数体部分算法复杂时应注释方式算法结构作出说明
3) 函数申请全局资源导致资源紧张应加注明(存文件柄等)
4) 函数副作定十分醒目方式(加号等)注明
5) 函数长度100语句行(包括注释)程序特殊求时(速度求等)例外
423 语句注释
1) 应易理解分支条件表达式加注释
2) 易理解循环应说明出口条件(GOTO程序应说明入口条件)
3) 长函数实现应语句实现功分段加概括性说明
4) 供文件函数调函数绝应全局变量交换数
424 常量变量注释
常量名字(宏机制语言中宏)声明应该名字作适注释注释说明点:
1) 保存值含义(必须)
2) 合法取值范围(选)
3) 全局量需逐点做充分说明
43 缩进规
431 控制结构缩进
程序应缩进形式展现程序块结构控制结构影响展示程序结构前提减少缩进层次采两种缩进方式:
1)
2)
if (expression )
{
statements
}
else
{
statements
}
if (expression ){
statements
}
else{
statements
}
432 缩进限制
程序宽度果超出页宽屏宽难读规范求折行缩进方法合表达式编写子程序方法限制程序宽度
1)程序行宽超80列超者应折行书写
2)建议函数缩进超5级超者应子块写子函数
3)算法程序身特性特殊求时超5级
文档香网(httpswwwxiangdangnet)户传
《香当网》用户分享的内容,不代表《香当网》观点或立场,请自行判断内容的真实性和可靠性!
该内容是文档的文本内容,更好的格式请下载文档