Linu内核代码风格.docxVIP

CodingStyle/Linux 内核代码风格 这是一个简短的文档，描述了 linux 内核的首选代码风格。代码风格是因人而异的，而且我不愿意把我的观点强加给任何人，不过这里所讲述的是我必须要维护的代码所遵守的风格， 并且我也希望绝大多数其他代码也能遵守这个风格。请在写代码时至少考虑一下本文所述的 风格。 首先，我建议你打印一份GNU 代码规范，然后不要读它。烧了它，这是一个具有重大象征性 意义的动作。 不管怎样，现在我们开始： 第一章：缩进 制表符是 8 个字符，所以缩进也是 8 个字符。有些异端运动试图将缩进变为4（乃至 2）个字符 深，这几乎相当于尝试将圆周率的值定义为3。 理由：缩进的全部意义就在于清楚的定义一个控制块起止于何处。尤其是当你盯着你的屏幕连续看了 20 小时之后，你将会发现大一点的缩进会使你更容易分辨缩进。 现在，有些人会抱怨 8 个字符的缩进会使代码向右边移动的太远，在80 个字符的终端屏幕上 就很难读这样的代码。这个问题的答案是，如果你需要 3 级以上的缩进，不管用何种方式你的代码已经有问题了，应该修正你的程序。 简而言之，8 个字符的缩进可以让代码更容易阅读，还有一个好处是当你的函数嵌套太深的时候可以给你警告。留心这个警告。 在 switch 语句中消除多级缩进的首选的方式是让“switch”和从属于它的“case”标签对齐于同一列，而不要“两次缩进”“case”标签。比如： switch (suffix) { case G: case g: mem = 30; break; case M: case m: mem = 20; break; case K: case k: mem = 10; /* fall through */ default: break; } 不要把多个语句放在一行里，除非你有什么东西要隐藏： if (condition) do_this; do_something_everytime; 也不要在一行里放多个赋值语句。内核代码风格超级简单。就是避免可能导致别人误读的表达式。 除了注释、文档和 Kconfig 之外，不要使用空格来缩进，前面的例子是例外，是有意为之。选用一个好的编辑器，不要在行尾留空格。 第二章：把长的行和字符串打散 代码风格的意义就在于使用平常使用的工具来维持代码的可读性和可维护性。每一行的长度的限制是 80 列，我们强烈建议您遵守这个惯例。 长于 80 列的语句要打散成有意义的片段。每个片段要明显短于原来的语句，而且放置的位置 也明显的靠右。同样的规则也适用于有很长参数列表的函数头。长字符串也要打散成较短的字符串。唯一的例外是超过 80 列可以大幅度提高可读性并且不会隐藏信息的情况。 void fun(int a, int b, int c) { if (condition) printk(KERN_WARNING Warning this is a long printk with 3 parameters a: %u b: %u c: %u \n, a, b, c); else next_statement; } 第三章：大括号和空格的放置 C 语言风格中另外一个常见问题是大括号的放置。和缩进大小不同，选择或弃用某种放置策 略并没有多少技术上的原因，不过首选的方式，就像 Kernighan 和 Ritchie 展示给我们的， 是 把起始大括号放在行尾，而把结束大括号放在行首，所以： if (x is true) { we do y } 这适用于所有的非函数语句块（if、switch、for、while、do）。比如： switch (action) { case KOBJ_ADD: return add; case KOBJ_REMOVE: return remove; case KOBJ_CHANGE: return change; default: return NULL; } 不过，有一个例外，那就是函数：函数的起始大括号放置于下一行的开头，所以： int function(int x) { body of function } 全世界的异端可能会抱怨这个不一致性是……呃……不一致的，不过所有思维健全的人都知道（ a）KR 是_正确的_，并且（b）KR 是正确的。此外，不管怎样函数都是特殊的（在C 语言中 ，函数是不能嵌套的）。 注意结束大括号独自占据一行，除非它后面跟着同一个语句的剩余部分，也就是do 语句中的 “while”或者 if 语句中的“else”，像这样： do { body of do-loop } while (condition); 和 if (x == y) { .. } else if (x y) { ... } el