【2012.10.10~2012.10.16】编程规范之报纸式代码

// // // // // // // //////2012/10/10// // // // // // // ///报纸式规范代码之一：标题(类名、方法名)名称应该像报纸标题一样微言大义。如下:

iPhone 5最快本月国内上市

换成类名应该是:

class IphoneIsComing
{
private Date date;
//...
}

// // // // // // // ///
///2012/10/11
// // // // // // // ///
报纸式规范代码之二：

像报纸一样，将文章(代码)大意写在代码文件的最前端。

这个并不是指宏或者什么语法限制(#pragma)之类的东西，
而是指前面讲解注释时说过的，

关于你的程序中算法的大意。

将你的程序思路，以及你的行动目的用注释语言说清楚，
这样更好与读代码者沟通交流。


// // // // // // // ///
///2012/10/12
// // // // // // // ///
报纸式规范代码之三：

代码也不要又臭又长。

如果代码量真的很大，

那就分成不同的标题写出来好了。(报纸新闻都是这么干的)

一般来讲，
单个文件的代码行数尽量不要超过500行(小型程序)
3000行(中型程序)
xxxx行(大型程序)
....

1000000行(这不是代码，是寂寞)。

千万不要把所有代码都写在一个文件里面，
原因很简单，

如果写出来的程序只有一个文件，

将会显得灰常不霸气。
 
// // // // // // // ///
///2012/10/13
// // // // // // // ///
报纸式规范代码之四：

同一个文件中的代码要分块写，并用空白行来隔开不同种类的内容。

这个同样也是一个习惯问题，
因为在平常编程的时候，

不论是否将代码分块写，

与最终运行结果都没有太大关系。

然而，
将不同内容分开，
这样既能让显得整洁，

更重要的是，

这样方便以后对代码进行重构,
——整合相同类型的代码块将会使这项工作容易许多。


// // // // // // // ///
///2012/10/14
// // // // // // // ///
报纸式规范代码之五：

记得每个结构(指被花括号所分隔的结构)之间要错开一个Tab的距离。

正如报纸在每段开头都要空格一样，
我们的结构块之间
也要有缩进。
一般我是习惯点击一下Tab,

不过有些编译器可以自动的为你补上一行缩进。

这样子就很容易分清楚不同的函数体或是条件体啦。


// // // // // // // ///
///2012/10/15
// // // // // // // ///
今天我们稍微讲一下代码规范的一个小细节：
不知道大家注意没有，
在一个函数中，

第一个花括号的位置是在哪里。

这个虽然没有固定的规范，
但是在这里建议大家按照C#的官方格式去写：
if,while等短时间内执行的语句上花括号写在小括号右边，

类，方法等语句上花括号写在下面一行。

这样自己就能很轻松的分辨出来到底那个是方法，

哪个是条件判断了。

同样结构也将一目了然。


// // // // // // // ///
///2012/10/16
// // // // // // // ///
报纸式规范代码之最后章节：
像报纸一样，

为用户而设计。

不同的报纸有不同的特色，
但是他们都具有共同的目的：

为读者而设计。

代码也是如此，要有一套属于自己的，并且整洁的风格:

void MoveTo({"path" = Vector3(0,1,0),Vector3(0,1,1),Vector3(0,1,2),Vector3(0,1,3),Vector3(0,2,4),"orientation" = "Linear"});

像这样的一行代码，正如一个不知名的小报一样，
让人非常不顺眼。
如果整理成下面这个样子

void MoveTo(
{"path"=
  Vector3(0,1,0),
  Vector3(0,1,1),
  Vector3(0,1,2),
  Vector3(0,1,3),
  Vector3(0,2,4),
  "orientation" =
  "Linear"});

就非常顺眼了。
其实不同的大师有不同的代码风格，
但是不管如何，
让代码保持整齐，
都是任何程序员应该有的自觉意识。