C语言最佳实践
上QQ阅读APP看书,第一时间看更新

1.2 坏代码的特点

“幸福的人都是相似的,不幸的人各有各的不幸。”这句来自经典名著《安娜·卡列尼娜》的名言也可以延伸到编码风格上——“良好的编码风格遵循统一的规范,坏代码各有不同的表现”。话虽如此,但根据笔者对大量代码的观察,坏代码的“坏”大致体现在如下4个方面。

排版:所有与代码的外观相关的问题都可以归于排版问题,比如不正确的对齐和缩进、省略该有的空格导致书写拥挤等。在良好的编码风格中,代码的对齐、缩进、空格都应该遵循统一的标准。

命名:包括不正确的术语、不符合习惯的名称、错误的时态、使用拼音、含有中文等特殊字符的文件名、命名风格不统一等。C语言本身虽然是独立的,但在传统上和英语息息相关,因此C代码中的命名也应该尽量遵循正确的英语语法和用法习惯。另外,变量和函数等的命名风格虽然没有“唯一正确”的标准,但在同一个程序或者项目中,命名风格应该统一。

过度使用:不分场合地过度使用某种语法特性。过度使用typedef(类型定义)便是一个典型的例子。过度使用类型定义,会导致其他程序员在阅读代码时无法快速知悉一个类型到底是结构体、枚举量、指针还是整数。

注释:注释是一种重要的代码文档工具,可以帮助程序员阅读自己或他人的代码。但是,不规范的注释常常会影响我们对代码的阅读和理解,如注释太多或太少、注释风格不统一、注释太花哨、注释的内容和代码脱节等。