C Header Style Guide

 

本指南不是用于转换标题的?教程或一步一步的指导.这是一个风格指南，代表了我们想要维护的ideal标题。目前并非我们控制的所有标题都符合本指南100％，但正在进行中的工作，所有新贡献都应尝试使用这些标准。

• 翻译应该是非常接近原来的，所以他们看起来很熟悉，可以轻松更新。
  
• 标识符（包括任何#define）不应该被更改，除非绝对必要。
  
• 较小的文件可以组合成一个较大的标题，如果它们将包含#include，并且都属于同一个库。
  
• 应保留原始许可证。
  
  

• 标题需要使用最新的FreeBASIC版本。
  
• 多个标识符之间的命名冲突（由于FreeBASIC的大小写不敏感）或标识符和FreeBASIC关键字应通过将下划线附加到一个标识符来解决。
  
• 应该使用extern“c”块而不是cdecl别名“...”用于函数声明或函数指针类型。
  
• 预处理器指令（包括#define）应该被保留。例外：如果它们仅用于为不同的C编译器选择选项，则删除，即外部的差异，那么这些可以被删除，除非它们提供对进一步代码的支持。选择编译器时，选择应该有利于GNU C.
  
• FreeBASIC关键字应该是小写。
  
  

• 如果适当，内联函数应转换为宏。
  
• 可能需要将结构声明，函数体或类似的预处理器指令移动到外部，因为在FreeBASIC中，它们将被限定。
  
• 在它们之间的多个行扩展的预处理器指令（例如函数声明或数组初始化器）的声明需要手动重写