关于代码风格

Posted 小z同学

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了关于代码风格相关的知识,希望对你有一定的参考价值。

我对代码风格的理解就是能使作者更好的写代码,能使阅者更好的读代码。
方法如段落,类如章节,代码的美感正如文字的美感,代码应是一种艺术。

代码该如何写

在写代码的过程中最重要的便是对章节和段落的安排。和写文章一样,段落之间存在着引用,如同盘根错节的树结构。当行文没有着重点,有血肉却无骨架时,说明该分章节了。一个章节归纳了一类相关联的段落,当然也引用着本章或其他章节中的段落,章节安排得妥当,便是一览无余。至于包、模块、项目,那便是书本、种类、领域,无须再做比喻。
总之行文不能根据立意来,因为没有人事先知道你的立意,相反立意应该遵照结构,他人才能从中读出你的立意,这个和我们操作数据库时禁止在可以复用的代码上用多表操作是一样的道理。

下面以org.apache.commons.io.FileUtils的writeStringToFile()方法为例,其中并没有很复杂的逻辑,我们可以集中精力来体会这段代码的行文之美(前两种是我补充的,可以作为一个结构逐渐建立的理解过程)




以上是关于关于代码风格的主要内容,如果未能解决你的问题,请参考以下文章

代码风格:关于左花括号位置的研究

Google代码风格指南

代码风格检查工具vera++

代码风格检查工具vera++

代码风格检查工具vera++

如何从代码中删除 C 风格的注释