网站搭建一般要,上海迪士尼网页制作,效果图网站哪个好,高端网站建设服务11 February 2015代码就是程序员的孩子#xff0c;给“孩子”取个好听的名字很重要#xff01; 我们在项目开发中#xff0c;接触到的变量、函数、类多数都是项目自己定义的#xff0c;往往都是为了解决一些特定的领域的问题#xff0c;引入了各种各样的概念#xff0c;代…11 February 2015 代码就是程序员的孩子给“孩子”取个好听的名字很重要 我们在项目开发中接触到的变量、函数、类多数都是项目自己定义的往往都是为了解决一些特定的领域的问题引入了各种各样的概念代码里面的名字就对应着问题领域或方案领域的这些概念所以对于一个命名良好代码规范设计简洁的系统要想非常快的理解一个系统最直接的方式就是RTFC(Read The Fucking Code)。对于一个不断演进的系统代码的可读性至关重要首要要解决的问题就是名字变量名、函数名、类名等都需要仔细斟酌认真对待一个能够简洁能够清晰表达概念和意图的名字就显得尤为重要。 阅读《代码整洁之道》这本书后发现其中说的内容在我们自己项目中比比皆是随便拿出一块代码都可以当做反面教材给大家讲半天。长时间积累导致代码发霉变质取名也是毫无章法信手拈来。阅读这样的代码撞南墙的心都有了。下面结合自己项目中的问题和《代码整洁之道》谈谈关于命名相关的原则。 更多内容http://game-lab.org/posts/zoc-cleancode-2/ 1. 原则名副其实 选名字是件严肃的事情选个好名字很重要。如果名字需要注释来补充那就不是个好名字。最重要的是要名副其实名字能表达出概念和意图。BAD: int t currentTime.elapse(e); // 消逝的时间,以毫秒计 ... if (t timeout_value) { Zebra::logger-debug(---一次循环用时 %u 毫秒-----, t); } GOOD: int elapsed_ms currentTime.elapse(e); ... if (elapsed_ms timeout_value) { Zebra::logger-debug(-----一次循环用时 %u 毫秒---, elapsed_ms); } 2. 原则避免误导 必须避免留下掩藏代码本意的错误线索避免使用与本意相悖的词提防使用不同之处较小的名称拼写前后不一致就是误导BAD: std::vectorint account_list; // _list就是一个误导, accounts会更好 bool sendToZoneServer(); // 和下面的函数差别很小 bool sendToZoneServers(); // sendToAllZoneServers会好点 3. 原则:做有意义的区分 代码是写给人看的,仅仅是满足编译器的要求,就会引起混乱以数字系列命名(a1,a2,...),纯属误导无意义的废话: a, an, the, Info, DataBAD: void copy(char a1[], char a2[]) { for (size_t i 0; a1[i] ! \0; i) a2[i] a1[i]; } GOOD: void copy(char source[], char dest[]) { for (size_t i 0; source[i] ! \0; i) dest[i] source[i]; } 4. 原则:使用可读的名字 避免过度使用缩写可读的名字交流方便猜一猜下面的类是干什么的和别人怎么说这几个类 根据这些简直变态的缩写如果没有注释基本上很难知道是干什么的当你和别人交流的时候你就不得不一个一个字母来念“X-L-Q-Y”、“L-T-Q Manager”鬼知道你说的是什么PS. XLQY-XianLvQiYuan仙履奇缘, LTQ-LiaoTianQun聊天群有这样的名字也是醉了。 BAD: class XLQY;
class FCNV; class LTQManager; 5. 原则:使用可搜索的名字 避免使用Magic Number避免使用单字母,或出现频率极高的短字母组合(注意度的把握)BAD: if (obj-base-id 4661) // 4661是啥玩意? { usetype Cmd::XXXXXXX; } int e; // 怎么查找? XXXX:iterator it; // 变量作用的范围比较大的时候,也不见得是个好名字 GOOD: #define OJBECT_FEEDBACK_CARD 4661if (OJBECT_FEEDBACK_CARD obj-base-id) { usetype Cmd::XXXXXXX; } 6. 原则:避免使用编码 匈牙利标记法 Windows API时代留下的玩意形如wdXX, dwXXX, strXXX类型变换导致名不副实就有可能出现明明是个DWORD变量名却是qwNum。PS.匈牙利命名对于我们这些在Linux下摸爬滚打的好多年的来说看着真心别扭。 成员前缀 形如m_name, m_xxx基本上都无视,为何要多次一举PS.说到这一点可能有些同学有不同意见了“我这样写是为了区分成员变量和临时变量啊”好像这样写也没什么大不了遵循代码规范即可。如Google的C代码规范私有变量形如xxx_加后缀_其目的除了让你知道这货是个私有变量还有一点就是防止有些人图省事把带私有变量直接public掉因为谁也不喜欢在代码里面看到大量这些带把的玩意。 接口和实现 接口名形如IXXX, I-接口修饰前缀类名形如CXXX, C-类修饰前缀这些修饰多数时候都是废话7. 原则:名字尽量来自解决方案领域或问题领域 使用解决方案领域名称写代码的同学多数都是都出自CS,术语、算法名、模式名、数学术语尽管用。如AccountVisitorVisitor模式实现的Account类。 使用问题领域的名称我们代码里面多数都是这些名称不明白找策划问问基本上都是功能相关的名称。 8. 原则:适当使用有意义的语境 良好命名的类、函数、名称空间来放置名称给读者提供语境只有两三个变量,给名称前加前缀事不过三,变量超过三个考虑封装成概念,添加struct或classBAD: // 看着整齐?使用方便?
DWORD love_ensure_type_; //当前的爱情保险类型 DWORD love_ensure_ret_; //购买爱情保险回应标示 DWORD love_ensure_total_; //现在已经盖章数目 DWORD love_ensure_..._; //... DWORD love_ensure_..._; //... 最后我们的C命名规范 文件名 首字母大写,多个词组合起来如: SceneUser.h Sept.h 类名/名称空间名 首字母大写多个词组合起来使用名词或名词词组避免使用C前缀如:CSept如: SceneUser SeptWar 函数名 首字母小写使用动词或动词词组避免使用孤立的全局函数,可以封装在类或名称空间里面get, set, is前缀的使用如: fuckYou(), levelup() 变量名 全部字母小写,多个词以下划线分隔私有成员变量加后缀_,公有变量不用避免使用孤立的全局变量,可以封装在类或名称空间里面如: quest_id, questid_取名是一件严肃的事情我们需要认真对待名字代表着一个个概念名字代表着你想表达的意图好名字是可读代码的首要条件 写下任何一行代码的时候心里都要想着自己的代码是给别人看的。为函数、变量、类取个好名字遵循规范和原则。见到不符合规范和原则的名字确毫不留情的干掉它特别是功能性的代码。转载于:https://www.cnblogs.com/mywolrd/p/4371597.html
