我们什么时候应该在源代码中插入空白行？

Question

我不确定在我的源代码中应该在哪里添加新的空白行.我想编写易于阅读和理解的漂亮代码.

它仅基于对象,还是基于概念？带示例的答案对我最有帮助.

Answer 1

我认为这是个人喜好或公司标准的问题，但在办公室里，即使我们有一些指导方针，每个人都有自己编写代码的方式，空白是差异之一。

我更喜欢使用很多空行。每次我的代码上下文发生变化时，我都会将此部分与上一个和下一个部分分开，并在之前注释整个块。

Answer 2

就个人而言,我没有使用太多的垂直空白 - 其他人会推荐比我下面描述的更多.只要在不同的东西之间存在某种视觉分离,我想看代码,而不是空白行.我倾向于:

• 非成员函数之间的一个空行(在C++中,在类外定义的成员函数之间)
• 类之间有一个空行.
• 注释之前和之后的单个空白行,与后面的多个函数/类相关,即在代码中定义"sections":"XML处理的辅助函数",即那种注释.
• 类中的成员函数之间没有空行
• 通常函数内部没有空行.如果一个函数分几个阶段,我可能会在它们之间加上空白行,或者只是在它们之间发表一条解释阶段的评论.很长的函数更有可能以这种方式用空格分解,而不是我认为很长的函数是一件特别好的事情.如果一个成员函数确实有内部空白行,我通常会将它与类中的其他成员函数分开,并用空行.

两条连续的空白线看起来有点让我怀疑,我自己也几乎没有这样做过.三只是在我的显示器上浪费了非常好的空间 - 任何想要分开的东西的人都应该将IMO放在不同的文件中.

用于自动记录的注释块(Javadoc,Doxygen,Pydoc等)也提供了视觉分离 - 比几行空格更多,并且比任何数量的空白更有效.

当您在团队中工作时,请复制您修改的任何文件的样式.请勿重新格式化以符合您自己的首选项,请勿使用首选格式添加新代码.既可以同意房屋风格,也可以与之共存.

Answer 3

查看 StyleCop 的源代码布局： http: //stylecop.codeplex.com/。
我还推荐 FxCop 或 ReSharper。
另外，Control K D 布局文档但不整理空白行？