<b>Google C++编程气势指南(五):命名约定</b>[VC/C++编程]
本文“<b>Google C++编程气势指南(五):命名约定</b>[VC/C++编程]”是由七道奇为您精心收集,来源于网络转载,文章版权归文章作者所有,本站不对其观点以及内容做任何评价,请读者自行判断,以下是其具体内容:
1.总体法则:不要随便缩写;2.宏、列举等利用全部大写+下划线;3.变量(含类、构造体成员变量)、文件、命名空间、存取函数等利用全部小写+下划线,类成员变量以下划线末尾,全局变量以g_开首;4.参考现有或相近命名约定……
命名约定
最重要的一致性法则是命名管理,命名望概直接可以直接肯定命名实体是:范例、变量、函数、常量、宏等等,无需查找实体声明,我们大脑中的情势匹配引擎依靠于这些命名法则.
命名法则具有一定随便性,但相比按个人爱好命名,一致性更重要,所以不管你怎么想,法则总归是法则.
1.通用命名法则(General Naming Rules)
函数命名、变量命名、文件命名应具有描写性,不要过度缩写,范例和变量应当是名词,函数名可以用“号令性”动词.
若何命名:
尽大概给出描写性名称,不要节俭空间,让别人很快理解你的代码更重要,好的命名挑选:
int num_errors; // Good.
int num_completed_connections; // Good.
丑陋的命名利用模糊的缩写或随便的字符:
int n; // Bad - meaningless.
int nerr; // Bad - ambiguous abbreviation.
int n_comp_conns; // Bad - ambiguous abbreviation.
范例和变量名普通为名词:如FileOpener、num_errors.
函数名普通是指令性的,如OpenFile()、set_num_errors(),拜候函数需求描写的更具体,要与其拜候的变量符合合.
缩写:
除非放到项目外也十清楚了,不然不要利用缩写,比方:
// Good
// These show proper names with no abbreviations.
int num_dns_connections; // Most people know what "DNS" stands for.
int price_count_reader; // OK, price count.Makes sense.// Bad!
// Abbreviations can be confusing or ambiguous outside a small group.
int wgc_connections; // Only your group knows what this stands for.
int pc_reader; // Lots of things can be abbreviated "pc".
不要用省略字母的缩写:
int error_count; // Good.int error_cnt; // Bad.
2.文件命名(File Names)
文件名要全部小写,可以包含下划线(_)或短线(-),按项目约定来.
可承受的文件命名:
my_useful_class.cc
my-useful-class.cc
myusefulclass.cc
C++文件以.cc末尾,头文件以.h末尾.
不要利用已经存在于/usr/include下的文件名(译者注,对UNIX、Linux等系统而言),如db.h.
普通,尽大概让文件名越发明确,http_server_logs.h就比logs.h要好,定义类时文件名普通成对呈现,如foo_bar.h和foo_bar.cc,对应类FooBar.
内联函数必须放在.h文件中,假如内联函数对比短,就直接放在.h中.假如代码对比长,可以放到以-inl.h末尾的文件中.关于包含大量内联代码的类,可以有三个文件:
url_table.h // The class declaration.
url_table.cc // The class definition.
url_table-inl.h // Inline functions that include lots of code.
参考第一篇-inl.h文件一节.
以上是“<b>Google C++编程气势指南(五):命名约定</b>[VC/C++编程]”的内容,如果你对以上该文章内容感兴趣,你可以看看七道奇为您推荐以下文章:
本文地址: | 与您的QQ/BBS好友分享! |