编码规范

 命名

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、使用源码控制工具代替日志式的注释。

全部评论

相关推荐

07-25 11:26
清华大学 Java
打开电脑,思绪又回到了7月份刚开始的时候,感觉这个月过的如梦如幻,发生了太多事,也算是丰富了我本就是平淡的人生吧太早独立的我习惯了一切都是自己做决定,拥有绝对的决定权,而且永远不会听取别人的建议。我就是那个恋爱四年出轨的男主啦,感觉既然在牛客开了这个头,那我就要做个有始有终的人。从我出轨到结束再到和女朋友和好如初真的太像一场梦了,短短的一个月我经历了太多,也成长了很多,放下了那些本就不属于我的,找回了那些我不该放弃的。我的人生丰富且多彩,但人不能一直顺,上天总会让你的生活中出点乱子,有好有坏,让你学会一些东西,让你有成长。我和女朋友的恋爱四年太过于平淡,日常除了会制造一些小浪漫之外,我们的生活...
段哥亡命职场:不得不说,我是理解你的,你能发出来足见你是个坦诚的人,至少敢于直面自己的内心和过往的过错。 这个世界没有想象中那样非黑即白,无论是农村还是城市,在看不见的阴影里,多的是这样的事。 更多的人选择站在制高点去谩骂,一方面是社会的道德是需要制高点的,另一方面,很多人不经他人苦,却劝他人善。 大部分的我们,连自己生命的意义尚且不能明晰,道德、法律、困境,众多因果交织,人会迷失在其中,只有真的走出来之后才能看明白,可是没走出来的时候呢?谁又能保证自己能走的好,走的对呢? 可是这种问题有些人是遇不到的,不去追寻,不去探寻,也就没了这些烦恼,我总说人生的意义在过程里,没了目标也就没了过程。 限于篇幅,没法完全言明,总之,这世界是个巨大的草台班子,没什么过不去了,勇敢面对,革故鼎新才是正确,祝你早日走出来。查看图片
点赞 评论 收藏
分享
06-17 21:57
门头沟学院 Java
白友:噗嗤,我发现有些人事就爱发这些,明明已读不回就行了,就是要恶心人
点赞 评论 收藏
分享
07-23 18:18
门头沟学院 Java
点赞 评论 收藏
分享
评论
点赞
收藏
分享

创作者周榜

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