工程实践：给函数取一个"好"的名字 - Matrix海子 - 博客园 (cnblogs.com)

我发现,我给函数起名简直就是一个老大难的问题,并不是不知道这个函数是干什么的,就是中文翻译成英文也觉得乖乖的,今天看到一篇博客,里面有好多常用的给函数取名的动词和名词,我决定以后每次给函数取名都看看里面的单词,从中选择与自己写的函数相关的单词.

2）要领2：名词使用领域词汇

　　举个例子：集合的容量通常用capacity、集合实际元素个数用size、字符串长度用length，这种就遵循大家的使用习惯，不要用size去形如字符串的长度。

　　再比如，假如使用到建造者模式，那么通常会用build作为函数名字，这个时候就不要另辟蹊径，用create来作为函数名字，使用大家约定俗成的命名习惯更容易让你的代码被别人读懂。

如何给函数取个合适的名字_慕课手记 (imooc.com)

命名函数的技巧

明确函数要做什么

在给函数命名前，明确函数到底要做什么。这有利于给函数命名。

以动词开头

函数总是做些什么，所以当然要以动词开头。

尽量不要以 do 开头

do 并不能给我们提供任何函数的信息。相比之下，search， compute， handle 之类的动词暗示着函数大概做了什么。

返回布尔值的方法以 is 或 are 开头

用 is 还是 are 取决于判断主体是单个还是多个。如：isButtonEnabled，areButtonsEnable。

合理的使用 get 作为函数名字的开头

所有有返回值的函数，好像都可以用 get 作为函数名字的开头。但以 get 开头的函数应该表示取某属性，如

var user = {firstName: '',lastName: '',getFirstName: function(){return this.firstName;},getFullName: function(){return this.firstName + this.lastName;}
}

否则就不应该用 get 开头。比如，从服务器上获取用户列表，这个方法可以叫 fetchUserList，而不是 getUserList；获取某个范围内的所有质数，可以叫 caculatePrime。

不要包含上下文信息

如有个 user 对象，有个获取 user 的 id 的函数，应该叫 getId 而不是 getUserId。

不要包含函数参数的信息

如用一个 id 和 token 找用户的方法，应该叫 findUser(userId, token) 而不是 findUserByUserIdAndToken(userId, token)。如果以 findUserByUserIdAndToken 来命名，那么如果以后函数要支持用其他方式查找用户怎么办，又或是不支持用 token 查找怎么办。

C++取名规范

C++命名规范 - 狂风劲雨 - 博客园 (cnblogs.com)

在软件开发这一高度抽象而且十分复杂的活动中，命名规则的重要性更显得尤为突出。一套定义良好并且完整的、在整个项目中统一使用的命名规范将大大提升源代码的可读性和软件的可维护性。

在引入细节之前，先说明一下命名规范的整体原则：

同一性	在编写一个子模块或派生类的时候，要遵循其基类或整体模块的命名风格，保持命名风格在整个模块中的同一性。
标识符组成	标识符采用英文单词或其组合，应当直观且可以拼读，可望文知意，用词应当准确。
最小化长度 && 最大化信息量原则	在保持一个标识符意思明确的同时，应当尽量缩短其长度。
避免过于相似	不要出现仅靠大小写区分的相似的标识符，例如“i”与“I”，“function”与“Function”等等。
避免在不同级别的作用域中重名	程序中不要出现名字完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但容易使人误解。
正确命名具有互斥意义的标识符	用正确的反义词组命名具有互斥意义的标识符，如："nMinValue"和"nMaxValue"，"GetName()" 和 "SetName()" ....
避免名字中出现数字编号	尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名字（因为用数字编号最省事）。

类/结构

除了异常类等个别情况（不希望用户把该类看作一个普通的、正常的类之情况）外，C++类/结构的命名应该遵循以下准则：

C++类/结构的命名	类的名称都要以大写字母“C”开头，后跟一个或多个单词。为便于界定，每个单词的首字母要大写。
推荐的组成形式	类的命名推荐用"名词"或"形容词＋名词"的形式，例如："CAnalyzer", "CFastVector" ....

不同于C++类的概念，传统的C结构体只是一种将一组数据捆绑在一起的方式。传统C结构体的命名规则为：

传统C结构体的命名

传统C结构体的名称全部由大写字母组成，单词间使用下划线界定，例如："SERVICE_STATUS", "DRIVER_INFO" ....

函数

函数的命名	函数的名称由一个或多个单词组成。为便于界定，每个单词的首字母要大写。
推荐的组成形式	函数名应当使用"动词"或者"动词＋名词"（动宾词组）的形式。例如："GetName()", "SetValue()", "Erase()", "Reserve()" ....
保护成员函数	保护成员函数的开头应当加上一个下划线“_”以示区别，例如："_SetState()" ....
私有成员函数	类似地，私有成员函数的开头应当加上两个下划线“__”，例如："__DestroyImp()" ....
虚函数	虚函数习惯以“Do”开头，如："DoRefresh()", "_DoEncryption()" ....
回调和事件处理函数	回调和事件处理函数习惯以单词“On”开头。例如："_OnTimer()", "OnExit()" ....

变量

变量应该是程序中使用最多的标识符了，变量的命名规范可能是一套C++命名准则中最重要的部分：

变量的命名

变量名由作用域前缀＋类型前缀＋一个或多个单词组成。为便于界定，每个单词的首字母要大写。

对于某些用途简单明了的局部变量，也可以使用简化的方式，如：i, j, k, x, y, z ....

作用域前缀

作用域前缀标明一个变量的可见范围。作用域可以有如下几种：

前缀	说明
无	局部变量
m_	类的成员变量（member）
sm_	类的静态成员变量（static member）
s_	静态变量（static）
g_	外部全局变量（global）
sg_	静态全局变量（static global）
gg_	进程间共享的共享数据段全局变量（global global）

除非不得已，否则应该尽可能少使用全局变量。

类型前缀

类型前缀标明一个变量的类型，可以有如下几种：

前缀	说明
n	整型和位域变量（number）
e	枚举型变量（enumeration）
c	字符型变量（char）
b	布尔型变量（bool）
f	浮点型变量（float）
p	指针型变量和迭代子（pointer）
pfn	特别针对指向函数的指针变量和函数对象指针（pointer of function）
g	数组（grid）
i	类的实例（instance）对于经常用到的类，也可以定义一些专门的前缀，如：std::string和std::wstring类的前缀可以定义为"st"，std::vector类的前缀可以定义为"v"等等。

类型前缀可以组合使用，例如"gc"表示字符数组，"ppn"表示指向整型的指针的指针等等。

推荐的组成形式

变量的名字应当使用"名词"或者"形容词＋名词"。例如："nCode", "m_nState"，"nMaxWidth" ....

常量

C++中引入了对常量的支持，常量的命名规则如下：

常量的命名

常量名由类型前缀＋全大写字母组成，单词间通过下划线来界定，如：cDELIMITER, nMAX_BUFFER ....

类型前缀的定义与变量命名规则中的相同。

枚举、联合、typedef

枚举、联合及typedef语句都是定义新类型的简单手段，它们的命名规则为：

枚举、联合、typedef的命名

枚举、联合、typedef语句生成的类型名由全大写字母组成，单词间通过下划线来界定，如：FAR_PROC, ERROR_TYPE ....

宏、枚举值

宏、枚举值的命名

宏和枚举值由全大写字母组成，单词间通过下划线来界定，如：ERROR_UNKNOWN, OP_STOP ....

转载--给函数取个好名相关推荐

python不允许使用关键字作为变量名、允许使用内置函数_【判断题】Python不允许使用关键字作为变量名,但是允许使用内置函数名作为变量名,不过这会改变函数名的含义,所以不建议这样做...
[判断题]Python不允许使用关键字作为变量名,但是允许使用内置函数名作为变量名,不过这会改变函数名的含义,所以不建议这样做更多相关问题 [单选,A2型题,A1/A2型题] <十四经发挥&g ...
python反序数函数_python range()函数取反序遍历sequence的方法
python range()函数取反序遍历sequence的方法 python中的range函数取反序有两种方式第一种:先构建一个列表,然后对列表中的元素进行反转. 例如: a=range(5) f ...
Python编程语言学习：python中与数字相关的函数(取整等)、案例应用之详细攻略
Python编程语言学习:python中与数字相关的函数(取整等).案例应用之详细攻略目录 python中与数字相关的函数 1.对小数进行向上取整 1.1.利用numpy库 1.2.利用math库
strtok函数取WinMain的参数
WinMain函数与main函数不同,main可以从argc得到函数个数,然后从argv[]数组里取参数. 而WinMain函数取参数是通过lpCmdLine,lpCmdLine里不能得到参数的个数. ...
mysql 变量作表名查询_使用MySQL函数变量作为表名查询
我需要有一个表中增加一定的ID(如AUTO_INCREMENT)函数使用MySQL函数变量作为表名查询我有水木清华这样 DELIMITER $$ DROP FUNCTION IF EXISTS `G ...
hive UDF函数取最新分区
hive UDF函数取最新分区 1.pom文件 <dependencies><!-- https://mvnrepository.com/artifact/org.apache.hi ...
php 查找键名,array_key_exists()函数搜索数组键名步骤详解
这次给大家带来array_key_exists()函数搜索数组键名步骤详解,array_key_exists()函数搜索数组键名的注意事项有哪些,下面就是实战案例,一起来看一下. array_key_ ...
VB选择文件夹并取文件夹名
代码如下: '引用Microsoft Shell Controls And Automation Dim ShellA As New Shell Private Sub Command1_Click( ...
python中求差的函数_python3函数取差是什么？如何写代码？
我们在数学中进行加减运算,两个数相减就可以得到差.今天小编就带来一个新问题,函数取差.有的小伙伴会很困惑,函数是一群英文使用,又不是数字怎么还能进行取差呢?这里也算是学习python有趣的地方,函数取 ...

转载--给函数取个好名

命名函数的技巧

C++取名规范

转载--给函数取个好名相关推荐

最新文章

热门文章