十一、 标识符命名
标识符命名要清晰明了,可以使用完整的单词和易于理解的缩写。
1、单词缩写
短的单词可以通过去元音形成缩写,较长的单词可以取单词中有意义的3个字母形成缩写。看别人的代码看多了就可以总结出一些缩写惯例,例如count写成cnt,block写成blk,length写成len,window写成win,message写成msg,number写成nrm,temporary可以写成tem,也可以进一步写成tmp,最有意思的是internationalization写成i18n,词根trans经常缩写成x,例如transmit写成xmt。
2、局部变量和函数名
内核编码风格规定变量、函数和类型采用全小写加下划线的方式命名,常量(比如宏定义和枚举常量)采用全大写加下划线的方式命名。
例如:
函数名radix_tree_insert( ) sort_msg( )
类型名struct radix_tree_root
常量名RADIX_TREE_MAP_SHIFT等。
3、 全局变量和全局函数的命名
全局变量和全局函数的命名在整个项目的许多源文件中都会用到,必须让使用者明确这个变量或函数是干什么用的,因此一定要详细,不惜多用几个单词多写几个下划线,或者用特殊字符加以标识。
例如:
函数名 char *get_msg_from_socket( );
全局变量名 char *__g_msg_que[MSG_MAX];
分享到:
相关推荐
代码风格是一个很个性化的东西,每个人都会有自己的喜好和见解。这里列出的是我个人的风格,并且是一般的代码风格。所谓一般是指文中没有对标识符的命名有太多的规定,如全局变量、局部变量、宏等。相关规则一般在...
应用程序(这里主要是指MFC,当然也可以用其他嵌入式代码书写)的标识符通常采用“大小写”混排的方式,如 AddChild。用程序的标识符通常采用“大小写”混排的方式,如 AddChild。对于命名发尽量用英文,如果没有...
内容概要 本文总结了Python中的标识符和保留字,包括标识符的规则和示例,以及Python的保留字...参考优秀的Python代码库和项目,学习他人的命名惯例和编程风格; 积极参与Python社区,与其他开发者交流经验和学习资源。
针对程序代码格式规范及代码维护的介绍。从标识符命名到排版风格,再到对注释的要求都有很详细的说明,能让大家养成很好的编码习惯!
3 标识符命名 4 可读性 5 变量、结构 6 函数、过程 7 可测性 8 程序效率 9 质量保证 10 代码编辑、编译、审查 11 代码测试、维护 12 宏 1 排版 ¹1-1:程序块要采用缩进风格编写,缩进的空格数为4个。 说明:对于由...
一、命名的两个基本原则1、含义清晰,不易混淆;2、不和其它模块、系统API的命名空间相冲突。二、命名通则1、在所有命名中,都应使用标准的...说明:个人的命名风格,在符合所在项目组或产品组的命名规则的前提下,才可
为了提高源程序的质量和可维护性,最终提高公司软件产品生产力,我们有必要对...本规范总则的内容包括:排版、注释、标识符命名、变量使用、代码可测性、程序效率、质量保证、代码编译、单元测试、程序版本与维护等。
本规范的内容涵盖了排版、注释、标识符命名、可读性、变量和结构、函数和过程、宏、可测性、程序效率、质量保证、代码编辑、编译和审查等。 本规范的使用者包括项目管理人员、软件设计人员、编程人员、软件测试人员...
本标准系公司首次发布实施,主要针对公司所有软件产品源代码范围的 C 和 C++编码风格,对 C 和 C++文件的版式、注释、标识符命名、可读性、变量、结构、函数和过程等方面均作出规范,以保障公司项目代码的易维护性和...
程序设计风格 1.1代码文档化 程序内部的文档包括:恰当的标识符(变量和标号)的名字、适当的注释和程序的视觉组织等。 1.标识符的命名 标识符包括模块名、变量名、常量名、标号名、子程序名以及数据区名、缓冲
〔三〕=====[标识符命名]======= 〔四〕=====[可读性]====== 〔五〕=====[变量、结构]===== 〔六〕=====[函数、过程]===== 〔七〕=====[可测性]===== 〔八〕=====[程序效率]===== 〔九〕=====[质量保证]===== 〔十〕...
程序设计风格 注 释 宏与常量 命名规范 源代码的排版 赋值语句的简写形式 程序设计风格全文共6页,当前为第1页。 注 释 注释的目的:增强程序的可读性、可维护性 注释的格式 格式一:"/*"与"*/"对,注释其中的部分...
Python 的代码风格由 PEP 8 描述。这个文档描述了 Python 编程风格的方方面面。在遵守这个文档的条件下,不同程序员编写的 Python 代码可以保持最大程度的相似风格。这样就易于阅读,易于在程序员之间交流。 python...
标识符命名惯例上(但不强迫)遵循见名知义原则和驼峰命名法。 《Java程序设计案例教程》教学课件02Java语言基础全文共48页,当前为第6页。 2.2 变量和常量 2.2.2 关键字 关键字是Java语言中已被赋予特定含义的...
可以作为毕设 课设 学习参考 实验目的 ...标识符的命名要到达顾名思义的程度; 关键代码提供清晰、准确的注释; 程序版面要求: 不同功能块用空行分隔; 一般一个语句一行; 语句缩进整齐、层次分明。
glib库是linux平台下最常用的c语言...它的编码风格是半面向对象,标识符加了一个前缀“g”,这也是一种通行的命名约定。使glib库的程序都应该包含glib的头文件glib.h。如果程序已经包含了gtk .h则不需要再包含glib.h。
良好的代码风格来自于同一的代码规范。风格良好的代码不仅具备可读性和可维护性,同时也给人行云流水、赏心悦目之快感。 据Microsoft公司统计,基于微软平台的开发中,有70-80%的印度工程师在完成同类算法或者模块时...
遵循程序设计编码规范,标识符应命名规范、代码注释充分、排版风格良好;要求系统具有良好的安全性,能有效防止非法登录用户访问需授权网页;系统具有良好的人机交互界面,界面应布局清晰、简洁大方;