程序中全局变量和函数的名称起着某种注释的作用。因此,不要选择简洁的名称,而应寻找能够提供有关变量或函数含义的有用信息的名称。在 GNU 程序中,名称应像其他注释一样使用英语。
局部变量名可以更短,因为它们仅在一个上下文中使用,并且(据推测)注释会解释其用途。
尽量限制在符号名称中使用缩写。可以使用一些缩写,解释它们的含义,然后频繁使用它们,但不要使用大量晦涩的缩写。
请使用下划线分隔名称中的单词,以便 Emacs 的单词命令可以在其中使用。坚持使用小写字母;保留大写字母用于宏和 enum
常量,以及遵循统一约定的名称前缀。
例如,您应该使用像 ignore_space_change_flag
这样的名称;不要使用像 iCantReadThis
这样的名称。
指示是否已指定命令行选项的变量应根据选项的含义命名,而不是根据选项字母命名。注释应说明选项的确切含义及其字母。例如,
/* Ignore changes in horizontal whitespace (-b). */ int ignore_space_change_flag;
当您想定义具有常量整数值的名称时,请使用 enum
而不是 ‘#define’。GDB 了解枚举常量。
您可能需要确保如果将文件加载到会缩短名称的 MS-DOS 文件系统上,则没有任何文件名会发生冲突。您可以使用程序 doschk
来测试这一点。
一些 GNU 程序被设计为将自身限制为 14 个字符或更少的文件名,以避免如果将它们读取到较旧的 System V 系统中时发生文件名冲突。请在现有的具有此功能的 GNU 程序中保留此功能,但在新的 GNU 程序中则不需要这样做。doschk
也会报告长度超过 14 个字符的文件名。