软件编码规范

合集下载

软件开发中的编码规范与标准

软件开发中的编码规范与标准

软件开发中的编码规范与标准编码规范是指在软件开发过程中,制定一个规范的标准,使得各种不同的程序员在编写代码时,能够遵循同一套规则,从而使得代码的可维护性、可读性、可扩展性更高,更容易维护和防止出现错误。

在软件开发中,编码规范的重要性不言而喻。

一个良好的编码规范可以避免因代码编写不规范而导致的各种问题,比如说代码难以阅读、调试时的错误或性能问题等等。

如果没有编码规范,每个开发者可能会采用自己的风格编程,最终的代码差异会很大,甚至相互冲突。

那么,软件开发中的编码规范和标准应该如何制定呢?以下是一些建议。

第一,编写代码时必须将变量名、函数名、注释等命名规则规范化,必须具有描述性,并且应尽可能短小精悍。

例如,在变量名中使用下划线或驼峰命名法,这符合通用编程规则,并且易于理解和维护。

第二,确保代码排版正确。

在大部分编程语言中,换行和缩进通常用于代码排版。

使用一种固定的排版风格可以使代码更具可读性,减少出错的可能性,并增强代码的可维护性和可扩展性。

第三,要有注释。

注释是代码中记录的重要信息,这些信息可以提高其他开发者的代码阅读能力,加快团队工作进程。

注释要有明确的意思,注释应该描述程序的行为,而不是重复底层操作的代码。

第四,避免编写过于复杂的代码。

过于复杂的代码容易出错并且不易维护,所以应尽量简化代码逻辑。

如果必须编写复杂的代码,应考虑注释、说明、使用设计模式等方式。

第五,定期进行代码评审和验证。

在团队中,评审代码可以促进代码品质的提高,还能够让团队中的每个成员学习到其他人的编程方式。

最后,为新加入开发团队的初学者编写代码规范指南。

为了更好的合作和提升整体开发能力,建议开发团队编写一份通用的代码规范指南,并让所有成员遵循这一标准,使得整个团队可以更高效,更容易理解并维护代码。

编码规范是软件开发中一个至关重要的环节。

良好的编码规范可以减少代码错误,增加代码可读性和可维护性,并让开发团队保持良好的合作关系。

虽然这只是软件开发的一小部分,但它对于软件开发的质量和成功与否起到重要的决定因素。

软件开发中的编码规范

软件开发中的编码规范

软件开发中的编码规范在软件开发中,编码规范是一个非常关键的方面。

编码规范可以提高代码质量,降低代码错误率,方便代码维护和交接。

这篇文章将会从多个方面探讨软件开发中的编码规范。

一、命名规范命名规范是编码规范的重要组成部分。

合理的命名规范表明了代码的含义,提高了代码可读性和可维护性。

以下是一些常见的命名规范:1. 类名、接口名使用大写开头的驼峰式命名法,比如SomeClass、MyInterface。

2. 方法名、变量名使用小写开头的驼峰式命名法,比如getSomeData()、myVariable。

3. 常量名使用全大写的下划线命名法,比如 MAX_VALUE、MIN_VALUE。

4. 包名使用小写字母,控制命名空间和组织代码结构。

二、缩进和空格代码的缩进和空格也是编码规范的重要部分。

适当的缩进和空格可以提高代码的可读性。

1. 使用4个空格作为一个单位的缩进,而不是制表符。

2. 在左括号前加一个空格,在右括号后加一个空格,如 if (condition) {。

3. 在二元运算符两边加上一个空格,比如 a = 1 + 2,而不是a=1+2。

三、注释规范注释是代码的重要组成部分,可以帮助其他开发者理解代码的含义。

以下是一些常见的注释规范:1. 类、接口、方法等应该有Javadoc类型的注释,描述它们的作用和参数、返回值等信息。

2. 方法内部的注释应该对复杂算法和思路进行解释和描述。

3. 使用单行注释和多行注释解释代码段的含义和用途。

四、异常处理在软件开发中,异常处理是必要的。

以下是一些异常处理的规范:1. 在try块中捕获异常,并处理它们。

2. 避免捕获不必要的异常,仅处理可能发生的异常。

这可以提高代码的性能和可读性。

3. 使用自定义的异常类来抛出错误,来减少代码中的魔法数字或字符串。

五、代码风格代码的风格应该是一致的,以提高代码的可读性。

以下是一些常见的代码风格规范:1. 按照功能将代码段组织成类和方法,避免代码重复和冗余。

软件开发中的编码规范和代码注释规范

软件开发中的编码规范和代码注释规范

软件开发中的编码规范和代码注释规范软件开发中的编码规范和代码注释规范随着计算机技术的不断发展,软件开发作为一门重要的技术也越来越受到人们的关注。

而在软件开发的过程中,编码规范和代码注释规范是非常重要的一环。

编码规范和代码注释规范的标准化不仅可以提高代码的可读性和可维护性,而且可以使得多人协同开发更加得心应手。

本文将从编码规范和代码注释规范两个方面来探讨其在软件开发中的重要性及应用方法。

一、编码规范编码规范是指在软件开发中制定的一套规定,用于规范代码的书写方式。

有了编码规范,开发人员可以更加高效地、统一地编写代码,从而降低开发过程中的错误率,节省时间和精力。

编码规范需要对一些书写细节进行标准化规范,下面我们来看一些常见的规范。

1.命名规范命名规范是指在命名变量、函数和类时的规则。

通常来说,命名应该反映变量、函数或类的作用和含义,应该采用有意义的词语,同时应该符合语言的命名规范,例如:1)变量名应该是一个名词,采用小写字母和下划线组成,如student_name。

2)函数名应该是一个动词,采用小写字母和下划线组成,如get_student_name。

3)类名应该是一个名词,采用大写字母开头的驼峰命名法,如StudentInfo。

2.注释规范注释规范是指在代码中添加注释,以便于代码的阅读和维护。

在注释时应该注意以下几点:1)注释应该使用简洁、明了的语言。

2)注释应该放在代码的上面或者右侧,而不是内嵌在代码中。

3)注释应该尽可能地详细描述代码的作用和逻辑,尤其是一些复杂的代码片段。

3.缩进规范缩进规范是指在编写代码时,应该按照一定的规则对代码进行缩进,以便于代码的可读性和可维护性。

通常来说,缩进应该按照以下原则进行:1)应该采用4个空格的缩进。

2)每个代码块应该有单独的缩进级别。

3)缩进应该注意对齐和排列方式。

二、代码注释规范在编写代码的同时,代码注释也是很重要的一环。

代码注释可以帮助其他人更好地理解代码和维护代码,在注释的时候应该遵循以下规范:1.注释类型通常来说,代码注释可以分为两种类型:行注释和块注释。

软件测试中的编码规范与质量标准

软件测试中的编码规范与质量标准

软件测试中的编码规范与质量标准在软件开发过程中,编码规范和质量标准是确保软件质量的重要因素。

编码规范是一组约定俗成的规则,用于指导开发人员编写可读性强、可维护性好的代码。

而质量标准则是用于评估软件的质量水平,以确保软件能够满足用户需求并具备高可靠性和稳定性。

首先,编码规范在软件测试中起到了至关重要的作用。

一个良好的编码规范可以提高代码的可读性和可维护性,从而减少软件缺陷的产生。

例如,规定变量和函数的命名规范、缩进和注释的使用规范等,可以使代码更易于理解和修改。

此外,编码规范还可以规范代码的结构和风格,使得团队成员之间的协作更加高效。

例如,规定代码的缩进方式、代码块的排列方式等,可以提高代码的一致性,减少不必要的冲突和错误。

其次,质量标准是评估软件质量的重要依据。

软件测试旨在发现和修复软件中的缺陷,以确保软件的正常运行和满足用户需求。

而质量标准则是用于评估软件测试的效果和软件的质量水平。

例如,测试覆盖率是一个常用的质量标准,用于衡量测试用例对软件代码的覆盖程度。

高测试覆盖率意味着测试用例更全面,能够发现更多的缺陷。

此外,质量标准还可以包括性能、可靠性、安全性等方面的指标,以确保软件具备良好的用户体验和稳定性。

在软件测试中,编码规范和质量标准是相互关联的。

良好的编码规范可以提高代码的质量,从而提高软件测试的效果。

而质量标准则可以对软件的质量进行评估,以指导开发人员遵循编码规范和改进软件测试的方法和策略。

因此,在软件测试中,开发团队应该制定并遵守一套合理的编码规范,并根据质量标准进行测试和评估。

然而,编码规范和质量标准并非一成不变的。

随着软件开发技术的不断发展和变化,编码规范和质量标准也需要不断更新和改进。

例如,随着敏捷开发和DevOps的兴起,软件开发过程变得更加快速和迭代。

因此,编码规范和质量标准也需要适应这种变化,并提供更加灵活和可持续的解决方案。

此外,不同的软件项目和领域也可能有不同的编码规范和质量标准。

软件研发项目编码规范与开发标准

软件研发项目编码规范与开发标准

软件研发项目编码规范与开发标准在软件研发项目中,编码规范与开发标准是至关重要的。

良好的编码规范可以增加代码的可读性和可维护性,提高团队合作效率,降低软件开发的错误率。

本文将探讨软件研发项目中编码规范与开发标准的重要性,并介绍一些常用的编码规范和开发标准。

首先,编码规范是指在软件开发过程中制定的一系列规则和约定,用来规范开发人员编写代码的风格和格式。

良好的编码规范可以使代码更易于阅读和理解,减少代码的bug和错误。

此外,编码规范还可以统一团队成员的编码习惯,提高团队合作效率。

因此,一个团队如果能够遵守一套统一的编码规范,在软件开发过程中将会更加高效和顺畅。

其次,开发标准是指在软件开发项目中约定的一套规范和标准,用来指导开发人员在软件开发过程中的行为和决策。

开发标准可以包括项目的架构设计、模块划分、代码管理、测试方法等方面的规范。

遵守开发标准可以确保项目的稳定性和可靠性,提高软件的质量和性能。

在实际的软件研发项目中,编码规范和开发标准起到了至关重要的作用。

在编写代码时,开发人员需要遵守统一的编码规范,确保代码的格式、命名规范、注释等方面符合规范要求。

在项目的架构设计和模块划分阶段,开发人员需要按照约定的开发标准进行规划和设计,确保项目的整体结构和组织清晰明了。

为了有效地制定和实施编码规范与开发标准,团队可以通过以下几个方面进行改进:1. 建立统一的编码规范和开发标准:团队需要制定一套统一的编码规范和开发标准,确保所有成员遵守相同的规范。

这些规范可以包括代码的格式、命名规范、注释规范等方面的要求。

2. 培训和指导开发人员:团队可以组织相关的培训和指导活动,帮助开发人员了解并遵守编码规范和开发标准。

通过培训,开发人员可以更好地理解规范的重要性,提高代码编写的质量和效率。

3. 使用自动化工具检查代码规范:团队可以借助一些自动化工具,如代码静态分析工具,来检查代码是否符合编码规范和开发标准。

这些工具可以帮助团队及时发现和纠正代码中的问题,提高代码的质量和可维护性。

软件开发编码规范

软件开发编码规范

软件开发编码规范
1. 前言
编码规范是一些制定约束和规范的方法。

在软件开发中,遵循编码规范可以帮
助开发者更轻松地开发出高效、高质量、易于维护和高性能的软件。

随着项目规模的增大和团队的扩大,软件代码不遵循规范所带来的问题也越来
越明显,为了便于团队协作,提高代码可维护性和可重用性,本文将详细介绍软件开发编码规范。

2. 命名规范
2.1 文件名
文件名应该简洁而具有描述性,使用推荐的文件命名规范。

文件名应全部小写,并使用连字符“-”分隔单词。

例如:
•my-awesome-file.js
•index.html
•my-awesome-file.css
2.2 变量名
变量名应该清晰、简洁和有描述性。

变量名应该遵循一定的命名规范,如下:•变量名应全部小写,并使用下划线“_”分隔单词。

•变量名应该具有描述性,且应该以其类型作为前缀,例如 strName、nCount 等。

•避免使用大小写区分变量类型的命名方式,如 intCount、sMessage 等。

例如:
int age;
string name;
float price_per_unit;
2.3 常量名
常量名要求全部大写,并使用下划线“_”分隔单词。

例如:
``` const int MAX_SIZE = 100; const char *MESSAGE =。

软件编码规范

软件编码规范

C#编码规范文档版本V0.011.目的规范C#代码的书写,提高代码的可读性,使开发人员在代码上更好的协作,减少新开发成员熟悉现有代码的时间,间接提高软件代码的可维护性。

2.命名规范1)命名约定标识符构成:所有标识符应由一个或多个完整的英文单词构成,除通用的缩略词如IO、Http、id等或是项目特定的专用缩略词如项目名称的缩写等,不应使用未被普遍接受的单词缩略形式。

可以适当使用下划线“_”。

2)大小写约定Pascal : 组成标识符的所有单词的首字母大写,如Get、BackColor。

Camel : 组成标识符的第一个单词全小写,后续单词首字母大小,如get、backColor。

全大写:组成标识符的所有单词的所有字母全部大写。

缩略词:➢不要使用半个单词的缩写形式,如GetWin,而应使用GetWindow。

➢不要使用不被普遍认可的首字母缩写。

在适当情况下,使用通用的首字母缩写,如UI表示User interface,而OLAP表示On-line Analytical Processing。

两个字母的缩写单独使用时可以适当使用全大写书写风格替代Pascal风格。

➢不要在标识符或参数名中使用首字母缩写,必须使用时,应使用Camel形式。

➢Id不是首字母缩写,不应使用全大写方式。

3)C#命名规范以.Net 公共语言规范(CLSCompliant)为基础,规定标识符的命名规则。

4)代码书写风格使用Visual Studio默认书写风格,在签入代码之前,应使用Ctrl + K, Ctrl + D快捷键格式化代码,保证源码管理服务器对代码差异的正确评估。

5)编码要求1.单个类、方法的代码行数不应过长,否则应考虑进行拆分。

2.局部变量引用Disposable类实例的,必须使用using 语法进行Dispose 操作。

或在特殊情况下,使用try{..} finally {…} 进行手动Dispose操作。

3.类的实例字段包含Disposable 类型的,类必须也要实现IDisposable接口。

软件编码规范

软件编码规范

软件编码规范软件编码规范是指在软件开发过程中,为了提高代码质量、可读性、可维护性和可扩展性,制定的一系列规范和标准。

遵循软件编码规范可以帮助开发团队保持一致的编码风格,并减少潜在的bug和错误。

下面是一个简要的软件编码规范:1. 缩进和格式化:- 使用空格进行缩进,每级缩进使用4个空格。

- 在代码块之间添加空行,以提高可读性。

- 对代码进行适当的格式化,使其具有良好的可视化效果。

2. 命名规范:- 使用有意义的变量、函数和类名,要求清晰简洁,并且能准确表达其用途和含义。

- 使用驼峰命名法或下划线分隔的命名风格。

- 避免使用缩写或简写,除非其含义在上下文中非常明确。

3. 注释规范:- 在代码中适当地添加注释,用于解释代码的意图和实现细节。

- 注释应该简洁明了,不冗余,不应该解释显而易见的事实。

- 解释代码的主要思路、算法和关键部分。

4. 函数和方法:- 函数和方法应该尽量保持简短和简单,一个函数或方法只做一件事情。

- 函数和方法的名称应该明确,能够表达其功能和目的。

- 避免使用全局变量,在函数和方法中应该尽量避免副作用。

5. 异常处理:- 在适当的地方进行异常处理,并提供有意义的错误信息。

- 不要吞噬异常,应该适当地处理异常,并向上层传递。

6. 安全性和性能:- 编写安全的代码,防范常见的安全漏洞,如SQL注入和跨站脚本攻击。

- 在编写代码时要考虑性能问题,避免不必要的资源消耗和性能瓶颈。

7. 单元测试和集成测试:- 编写单元测试和集成测试,确保代码的正确性和稳定性。

- 测试用例的命名应该明确,能够清楚表达其测试目的。

8. 版本控制和代码管理:- 使用版本控制系统,如Git,进行代码管理。

- 使用合适的分支策略和代码合并规范,确保代码的一致性和稳定性。

最后,软件编码规范应该根据具体的项目和团队的需求进行制定,灵活适应变化,并且应该经常进行审查和更新,以确保规范的有效性和适用性。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

软件编码规范编制审核批准发布日期 20XX-XX-XX目录1 计划规范 (6)1.1考虑冗余时间 (6)1.2尽早制定软件部署方案和用户反馈方案 (6) (6)2 版本规范 (8)3 C/C++代码规范 (9)3.1排版、布局 (9)3.2注释 (11)3.3命名 (13)3.4可读性 (14)3.5变量、结构 (14)3.6函数、过程 (15)3.7类 (16)3.8可测性 (16)3.9程序效率 (17)3.10质量保证 (17)3.11代码编辑、编译、审查 (18)3.12代码测试 (19)3.13宏 (19)3.14其他 (21)阅读说明:◆加“【强制】”的条款为必须满足的内容。

◆加“【建议】”的条款为建议性的内容,根据具体情况实行,不做检查。

◆加“【说明】”的为补充性内容,可以作为实行与检查的依据。

◆其他条款默认为检查项,如果在某些情况下违反,说明理由。

1计划规范1.1 考虑冗余时间软件设计的工时预估是世界公认“估不准”问题,这是导致软件行业“加班”与“跳票”的重要原因。

现在比较通行的做法是:◆【建议】软件设计工作划分得尽量细;◆【建议】由具体的设计人员和上一级管理者预估具体任务的完成时间;◆【建议】在所有统计工时的基础上增加80%的时间;◆【建议】根据工作的进展尽早汇报并调整计划;1.2 尽早制定软件部署方案和用户反馈方案◆【建议】有些部署与反馈方案要在软件内部实现,比如:在线升级、故障数据保存与发送。

这些是软件设计的一部分,应整体考虑。

2版本规范◆【建议】软件产品(可执行文件、动态库等)和安装包使用如X.Y.Z.T的四段版本。

X.Y为主版本号,Z:功能变化时+1;T:逐次编译+1;功能变化且重新编译时,Z+1,T重新置0。

3C/C++代码规范3.1 排版、布局【目标】清晰,利于阅读,防范低级错误。

◆缩进为4个字符宽(使用TAB键,其宽度设置为4个空格)。

◆【建议】函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。

◆【建议】程序块的分界符(如‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。

在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

◆【建议】预处理指令不需要缩进,总是从行首开始。

即使预处理指令位于缩进代码块中,指令也应从行首开始。

◆相对独立的程序逻辑块之间加空行。

◆【建议】函数内部逻辑块之间加入一个空行,每个类声明后加入空行,函数之间加两个空行。

◆【建议】代码行长度超过80个字符时分行。

◆【建议】较长的语句要分成多行书写,划分出的新行要进行适当的缩进,使排版整齐,语句可读。

◆【建议】长表达式要在低优先级操作符处划分新行,操作符放在新行之首。

◆若函数由于参数过程多而使语句过长,则每个参数(包括类型)单独一行参数行对齐。

◆【建议】循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分。

◆【建议】若函数或过程中的参数较长,则要进行适当的划分。

◆不允许把多个短语句写在一行中,即一行只写一条语句(宏定义与闭包中的除外)。

◆if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。

◆程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。

◆【建议】适当加入空格使语句语义清晰。

由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在C/C++语言中括号已经是最清晰的标志了。

◆【建议】在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格。

比如:a = b + c;◆【建议】象const、virtual、inline、case 等关键字之后至少要留一个空格,否则无法辨析关键字。

象if、for、while等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。

◆【建议】函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。

◆【建议】‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。

◆【建议】‘,’之后要留空格,如Function(x, y, z)。

如果‘;’不是一行的结束符号,其后要留空格。

⏹【建议】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格;一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格;象“[]”、“.”、“->”这类操作符前后不加空格。

◆【建议】在较长语句中,体现层次性更重要。

按操作符的优先级,适量加入空格,不必处处都加。

比如:a = x>0 ? b : c;要比:a = x > 0 ? b : c;清晰。

再比如:if (int i=0; i<MAX_CI; i++)要比:if (int i = 0; i < MAX_CI; i++)清晰。

◆【建议】遵从统一的顺序书写类的定义及实现。

类的定义(在定义文件中)按如下顺序书写:公有函数公有属性保护函数保护属性私有函数私有属性类的实现(在实现文件中)按如下顺序书写:构造函数析构函数公有函数保护函数私有函数3.2注释【目标】增加足够的信息量,利于理解。

◆在源码相关文件、编译配置文件(如MAKE文件,config文件)和其它脚本文件(如安装脚本充分文件)的头部应进行注释。

◆【建议】文件头注释包含版权声明与应用问题的说明。

示例:/********************************************************************** 版权所有(c)2008,重庆微海软件开发有限公司。

* Copyright (c) MicroSea Software Development Co. Ltd, All rights reserved.**问题:同步方式在某些情况下会造成消息丢失,原因未明,建议使用异步方式*注意:MetaDataProc2未经充分测试**********************************************************************/◆【说明】版权说明要包括中文和英文。

◆【说明】注释通常用中文写,但可以适度用简单英文,如下例中“param1”。

◆【强制】说明每个全局或公有函数的功用、参数及返回值。

示例://purpose:用指定的宽和高生成8位DibSection对象//param0:宽//param1:高//param2:[out],实际输出的是DibSection*指针//return:错误码,定义见define2.hint CreateDibSetion8(UINT width, UINT height, void**ppDibSetion);◆【强制】说明每个全局或公有属性、变量和常量的意义。

◆【强制】对于每个自定义类型(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释说明用途。

◆【说明】类型、方法、变量、宏定义等,作用域越大的,注释说明应该越多。

对私有的函数和属性按需要加注释。

◆【建议】在函数内部对逻辑分支加注释,说明什么情况下到这一分支。

◆【建议】对循环体进行注释,说明用途、循环的结束/跳出条件。

◆【建议】对特定的算法加详细说明。

◆【建议】边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。

不再有用的注释要删除。

◆【说明】注释的内容要清楚、明了,含义准确,防止注释二义性。

错误的注释不但无益反而有害。

◆【建议】注释中出现不常见的名词或缩写时进行名词解释,或给出参考资料的位置。

◆注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对短语句或变量)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。

注释与所描述内容进行同样的缩排。

◆【建议】对于所有有物理含义的变量、常量,注释说明其单位。

◆【建议】通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。

◆【建议】对于未引用的函数参数,使用C风格注释将参数名注释掉。

◆【建议】在程序块的结束行右方加注释标记(‘}’的右方),以表明某程序块的结束。

◆【建议】允许个性化,但同一模块注释风格尽量统一。

3.3命名【目标】含义贴切,用途清晰明了。

“吟安一个字,捻断数茎须”,代码中的命名虽不这样追求极致,但“命名”确是世所公认的程序员第一难题。

项目及文件的命名需要在一开始就考虑的十分合理。

对于文件内部的各种命名,在设计过程中,如果发现有更贴切表意、更合理的,替换之。

◆【建议】除了约定俗成的少数缩写或简写(如msg(message)、inc(increment)),命名尽量用完整的单词。

◆【建议】命名中若使用特殊约定或缩写,则要有注释说明。

◆【说明】对包括文件名、类名、结构体名、变量名、常量名等在内的命名,既可以使用驼峰式命名方式(如TheExample),也可以用UNIX式(如the_example)。

UNIX 式更易读,但是在Windows下编程,要考虑风格兼容问题。

◆【建议】文件名尽量使用UNIX式。

因为SVN源码管理系统对大小写是敏感的。

◆【建议】IDE生成的代码文件,后续的添加保持其风格。

与框架(如MFC)直接打交道的代码,使用框架的风格。

◆【强制】除了引用的内容(比如使用其他的库)代码风格至少在文件内部保持统一。

◆【建议】代码风格在模块级或命名空间及保持统一。

◆【建议】类名、结构体名、函数名使用首字母大写的驼峰式。

◆【建议】变量、常量使用驼峰式命名方式,首字母小写。

类成员变量前加m_,全局变量前加g_,常量前加k。

◆【建议】摈弃匈牙利命名法中类型的缩写前缀,只保留‘sz’、‘p’和‘pp’。

◆【建议】对于变量命名,除非在循环体内用作计数,禁止取单个字符。

◆【建议】程序中不要出现仅靠大小写区分的相似的标识符。

◆【建议】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

add / remove begin / end create / destroyinsert / delete first / last get / releaseincrement / decrement put / getadd / delete lock / unlock open / closemin / max old / new start / stopnext / previous source / target show / hidesend / receive source / destinationcut / paste up / down◆【强制】宏名称中不使用小写字母。

相关文档
最新文档