- 8
- 0
- 约9.44千字
- 约 20页
- 2017-01-06 发布于重庆
- 举报
代码规范(审查版)
1?目的
为了统一公司软件开发的设计过程中关于代码编写时的编写规范和具体开发工作时的编程规范,保证代码的一致性,便于交流和维护,特制定此规范。
2?范围
本规范适用于开发组全体人员,作用于软件项目开发的代码编写阶段和后期维护阶段。
3?注释规范
3.1?概述
a)??注释要求英文及英文的标点符号。
b)??注释中,应标明对象的完整的名称及其用途,但应避免对代码过于详细的描述。
c)?? 每行注释的最大长度为100个字符。
d)??将注释与注释分隔符用一个空格分开。
e)??不允许给注释加外框。
f)?? 编码的同时书写注释。
g)?? 重要变量必须有注释。
h)?? 变量注释和变量在同一行,所有注释必须对齐,与变量分开至少两个“Tab”键。
如:int? m_iLevel,m_iCount;???? // m_iLevel tree level
// m_iCount count of tree items
string m_strSql;??????????? //SQL
i)???典型算法必须有注释。
j)???在循环和逻辑分支地方的上行必须就近书写注释。
k)???程序段或语句的注释在程序段或语句的上一行
l)???在代码交付之前,必须删掉临时的或无关的注释。
m)???为便于阅读代码,每行代码的长度应少于100个字符。
3.2??自建代码文件注释
对于自己创建的代码文件(如
您可能关注的文档
- BP算法过程.docx
- 非线性03典型混沌电路及其分析.doc
- 高数(上)前三章知识点总结.doc
- 数列极限与函数极限的统一.doc
- 汽车雨刷器设计..doc
- 2009-2010学年第二学期《工程测试技术》期末试卷_A_及答案.doc
- 汽车零件名称中英文对照..doc
- 汽车零部件供应商质量协议模版..doc
- 2014年高考理综化学试题和答案(全国卷1)(高清WORD版) 2.doc
- 汽车零部件检测标准..doc
- 中国国家标准 GB/Z 18975.11-2026工业自动化系统与集成 流程工厂(包括石油和天然气生产设施)生命周期数据集成 第11部分: 基于RDFS方法论的参考数据工业简化用法.pdf
- GB 51251-2017 建筑防烟排烟系统技术标准 正式版加条文.pdf
- 《建筑防烟排烟系统技术标准》GB51251-2017(170822报批稿)规范.pdf
- 2025年人形机器人市场研究报告.docx
- 2025年人形机器人市场研究报告.pdf
- 从对话到执行:OpenClaw企业级智能体应用手册.pdf
- 《商业模式创新》.pdf
- Openclaw龙虾全维度安全实战指南.pdf
- 2025年IT行业项目管理调查报告.pdf
- 2025年宠物洗护市场复盘总结及新品趋势.pdf
原创力文档

文档评论(0)