C语言代码编写规范
个人整理的C语言代码编写的规范,用于统一软件开发人员的代码风格,便于进行代码管理维护工作。
C#代码编写规范
1 目的
为了统一公司软件开发的设计过程中关于代码编写时的编写规范和具体开发工作时的编程规范，保证代码的一致性，便于交流和维护，特制定此规范。
2 范围
本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。
3 注释规范
3.1 概述
a) 注释建议使用英文及英文的标点符号。
b) 注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。 c) 每行注释的最大长度为100个字符。
d) 不允许给注释加外框。
e) 编码的同时书写注释。
f) 重要变量必须有注释。
g) 变量注释和变量在同一行，所有注释必须对齐，与变量分开至少两个“Tab”键。 如：int m_iLevel,m_iCount; // m_iLevel ....tree level
// m_iCount ....count of tree items
string m_strSql; //SQL
h) 典型算法必须有注释。
i) 在循环和逻辑分支地方的上行必须就近书写注释。
j) 程序段或语句的注释在程序段或语句的上一行
k) 在代码交付之前，必须删掉临时的或无关的注释。
l) 为便于阅读代码，每行代码的长度应少于100个字符。
3.2 自建代码文件注释
对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释： /******************************************************
FileName:
Copyright (c) 2004-xxxx *********公司技术开发部
Writer:
create Date:
Rewriter:
Rewrite Date:
Impact:
Main Content（Function Name、parameters、returns）
******************************************************/
3.3 模块（类）注释
模块开始建议使用以下形式书写模块注释：
你可能喜欢
- 软件编程规范
- 软件开发规范
- 软件测试
- 文明用语
- 商场营业员
- 家长委员会会议记录
- 语言修养
- 做文明的中学生
- 软件开发编程规范5页
- 软件编程规范培训实例与练习70页
- 软件编程规范(MISRA_C)44页
- 软件编程规范43页
- 手机软件C编程规范(V1.0)57页
- 软件编程规范—Java东南融通34页
- 软件开发编程规范5页
- 软件开发过程规范11页
- B+S软件开发测试规范_试行21页
- DZ-T 0169-1997 物探化探计算机软件开发规范8页
- 软件开发管理规范5页
- 计算机软件产品开发的标准化规范化要求4页
- 软件测试技术与实践_第3章 测试计划和缺陷跟踪纠正28页
- 软件工程测试文档13页
- 第6章 软件测试121页
- 嵌入式软件白盒测试技术104页
- 软件测试经典面试题46页
- 01.软件测试实践47页
- 商场营业员培训16页
- 商场营业员培训课件(服务礼仪)23页
- 商场营业员季度工作总结7页
- 商场营业员薪酬办法2页
- 商场营业员2011年工作总结1页
- 家电商场营业员年度工作总结1页
- 如何提高语言修养3页
- 浅析护士语言修养1页
- 如何提高声乐教师的教学语言修养5页
- 教师语言的修养1页
- 中学地理教师的语言修养4页
- 试论护士语言修养1页
