养成良好的Linux编码风格(1)

养成良好的Linux编码风格(1)

Linux操作系统是一个开源的操作系统，为此你在Linux系统上开发的一个工具软件，包括源代码，可能其他系统管理员也需要用到。为此在编写代码的时候，就需要遵守一定的规则。这不仅是为了方便他人的阅读，也是为了以后自己的维护与升级考虑。具体的来说，笔者认为Linux系统管理员要养成下面的一些好的编码风格。

一、 合理防治函数开头的左花括号。

根据大部分系统管理员认可的编码风格，往往将函数开头的左括号放到代码页的最左边。要避免将其他的括号(包括左花括号、左括号或者左方括号)放到最左边。这主要是为了便于阅读。因为函数的主体内容往往是有一对花括号括起来的。如果在代码页的最左边只有代表函数的花括号，那么就可以一目了然的看到函数的主体。为此这是提高代码阅读性的一个很好的手段。

需要注意的是，这可能跟其他语言的编程风格有所差异。如在Java语言或者C语言平台上，往往将函数主体开头的花括号放在函数的后面。如在main函数后面会直接使用{这个左花括号。不过这不利于程序的阅读，不利于Linux系统管理员找到函数的主体代码。为此如果有其他编程语言使用经验的系统管理员，最好能够改变这种书写习惯。笔者建议，系统管理员还是要将这个花括号放在最左边，并保证在整个代码中，最左边出现的花括号都是代码函数主体的花括号。

二、 每个函数开头最好都有一个简短的代表功能的说明。

在Linux的功能代码中，其各个功能也都是一个个函数或者程序构成的。也就是说，在一个代码文件中，可能会有很多个函数构成。那么这些函数主要用来实现什么功能呢?如果不做任何说明的话，那么只有看完函数的全部代码之后才能够了解这个信息。这对于他人阅读源代码会造成比较大的障碍。而且，时间久了之后，可能连系统管理员自己都不知道这个函数时用来实现什么功能的。这对于其后续维护与升级显然是不利的。为此笔者建议各位系统管理员，无论是为自己还是为他人，最好在每个函数或者程序的开头都写上一小段注释。好记性不如烂笔头，这对于提高代码的易读性。另外需要说明的是，由于Linux系统可能对中文的支持并不是很好，为此在写这个注释的时候，最好采用英文书写。因为在一些对中文支持并不是很好的系统中，这个中文会显示为乱码，此时就起不到应有的作用了。如果不懂英文的话，那么可能只有使用拼音了。当然这只是笑话。一般Linux系统工程师对于英文需要一定的了解。因为Linux操作系统中的帮助文档都是英文写的。所以这个英文的语言关也是系统管理员必须要解决的关口。

另外在对函数进行说明时，最好还需要著名这个函数需要用户传入什么参数，会返回什么样的结果。以及参数、结果的个数等等。这对于代码的编译与维护非常有帮助。而且项目团队中的其他成员如果要引用你这个函数的话，那么不需要查看函数的具体代码。而只需要查看一些这个注释，就可以知道需要传递进去哪些参数。这也是提高项目合作效率的一个手段。