编码规范

 命名

1、尽量不要用缩写词,比如msg、hp、list、a、b、...;这样很难看出代码要表达的意图,尽可能的使用能够表达清楚的词语或者短语,因为这个年代,已经有足够大的磁盘空间存放你的程序文件了。

2、做有意义的区分,很多时候为了省事,同类型的变量你会写成number1、number2、number3...。

3、不要添加冗余的前后缀,例如CustomerInfo、CustomerData、NameString、...直接用Customer、Name要比添加Info之类要简单清晰。

4、不要去创造或使用一些,连自己都读着绕口或者错误的名称,比如(西瓜Watermelon),不要写出这样的词语-WestFellow,如果不知道,你不会傻到连翻译工具都不会用吧。

5、比较有争议的一些命名方式,接口“I”前缀,变量前面加“_”;如果你觉得好就放心大胆的用吧。

6、类名应该使用名词或名词短语,例如Customer,Account、...避免使用Data、Info、Manager、...这样的类型,类名不应该用动词。

7、方法名应该用动词或者动词短语。

  函数

1、尽量简小。

2、一个函数只做一件事,即看方法能不能再拆分出一个新的函数,而行的函数和该函数要做的不是同义层级的事。通过自顶向下的方式,阅读你的代码,将同一抽象级别的代码放在一起。

3、如果函数的参数操作三个以上,就要想着该把参数封装成一个类。

  注释

1、优秀的代码,没有注释,代码本身就是说明一切。所以,尽可能的把代码写好吧。

2、如果做不到第一条,你还是乖乖的给代码写上注释吧,否则没人知道你的代码要干什么。

3、避免长篇大论的写一些没有用的信息。

4、合理的使用//TODO,为未完成的任务或者将来可能需要优化的地方加上备注。

5、使用源码控制工具代替日志式的注释。

全部评论

相关推荐

头像
10-13 18:10
已编辑
东南大学 C++
。收拾收拾心情下一家吧————————————————10.12更新上面不知道怎么的,每次在手机上编辑都会只有最后一行才会显示。原本不想写凉经的,太伤感情了,但过了一天想了想,凉经的拿起来好好整理,就像象棋一样,你进步最快的时候不是你赢棋的时候,而是在输棋的时候。那废话不多说,就做个复盘吧。一面:1,经典自我介绍2,项目盘问,没啥好说的,感觉问的不是很多3,八股问的比较奇怪,他会深挖性地问一些,比如,我知道MMU,那你知不知道QMMU(记得是这个,总之就是MMU前面加一个字母)4,知不知道slab内存分配器->这个我清楚5,知不知道排序算法,排序算法一般怎么用6,写一道力扣的,最长回文子串反问:1,工作内容2,工作强度3,关于友商的问题->后面这个问题问HR去了,和中兴有关,数通这个行业和友商相关的不要提,这个行业和别的行业不同,别的行业干同一行的都是竞争关系,数通这个行业的不同企业的关系比较微妙。特别细节的问题我确实不知道,但一面没挂我。接下来是我被挂的二面,先说说我挂在哪里,技术性问题我应该没啥问题,主要是一些解决问题思路上的回答,一方面是这方面我准备的不多,另一方面是这个面试写的是“专业面试二面”,但是感觉问的问题都是一些主管面/综合面才会问的问题,就是不问技术问方法论。我以前形成的思维定式就是专业面会就是会,不会就直说不会,但事实上如果问到方法论性质的问题的话得扯一下皮,不能按照上面这个模式。刚到位置上就看到面试官叹了一口气,有一些不详的预感。我是下午1点45左右面的。1,经典自我介绍2,你是怎么完成这个项目的,分成几个步骤。我大致说了一下。你有没有觉得你的步骤里面缺了一些什么,(这里已经在引导我往他想的那个方向走了),比如你一个人的能力永远是不够的,,,我们平时会有一些组内的会议来沟通我们的所思所想。。。。3,你在项目中遇到的最困难的地方在什么方面4,说一下你知道的TCP/IP协议网络模型中的网络层有关的协议......5,接着4问,你觉得现在的socket有什么样的缺点,有什么样的优化方向?6,中间手撕了一道很简单的快慢指针的问题。大概是在链表的倒数第N个位置插入一个节点。————————————————————————————————————10.13晚更新补充一下一面说的一些奇怪的概念:1,提到了RPC2,提到了fu(第四声)拷贝,我当时说我只知道零拷贝,知道mmap,然后他说mmap是其中的一种方式,然后他问我知不知道DPDK,我说不知道,他说这个是一个高性能的拷贝方式3,MMU这个前面加了一个什么字母我这里没记,别问我了4,后面还提到了LTU,VFIO,孩子真的不会。
走呀走:华子二面可能会有场景题的,是有些开放性的问题了
点赞 评论 收藏
分享
评论
点赞
收藏
分享

创作者周榜

更多
牛客网
牛客网在线编程
牛客网题解
牛客企业服务