原创 C头文件

------------sysint.h----------
#ifndef _SYSINT_H_
#define _SYSINT_H_
#define PI 3.1415926
extern void SysInit(void);
#endif
-----------sysint.c-----------
＃include <stdio.h>
＃include"sysint.h"
void SysInit(void)
{
 printf("系统初始化成功")；
}
-----------main.c--------------
＃i nclude<stdio.h>
＃i nclude"sysint.h"
main()
{
    float i;
    SysInit();
    i="3"*PI;
    printf("%f",i);
    getchar();
}
一开始写的时候，在main函数中的 Sysinit（）前加了个void，结果成了函数声明，搞的结果一直出不来，最后经过检查终于成功了！

头文件由三部分内容组成：
（1）头文件开头处的版权和版本声明（参见示例1-1）。
（2）预处理块。
（3）函数和类结构声明等。
假设头文件名称为 graphics.h，头文件的结构参见示例1-2。
【规则1-2-1】为了防止头文件被重复引用，应当用ifndef/define/endif 结构产生预处理块。
【规则1-2-2】用 #include <filename.h> 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。
【规则1-2-3】用 #include “filename.h” 格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。
【建议1-2-1】头文件中只存放“声明”而不存放“定义”
在C 语法中，类的成员函数可以在声明的同时被定义，并且自动成为内联函数。
这虽然会带来书写上的方便，但却造成了风格不一致，弊大于利。建议将成员函数的定义与声明分开，不论该函数体有多么小。
【建议1-2-2】不提倡使用全局变量，尽量不要在头文件中出现象extern int value 这类声明。

如何写出专业的C头文件
作者：      来源：zz     发表时间：2007-05-23     浏览次数： 4271      字号：大  中  小

做到专业，应该是每个职业程序员应该要求自己做到的。
让我们看看lua是怎么写头文件的。

1.License Agreement
License Agreement应该加在每个头文件的顶部。
Lua Sample:

/*
** $Id: lua.h,v 1.175b 2003/03/18 12:31:39 roberto Exp $
** Lua - An Extensible Extension Language
** Tecgraf: Computer Graphics Technology Group, PUC-Rio, Brazil
** http://www.lua.org    mailto:info@lua.org
** See Copyright Notice at the end of this file
*/
 

2.guard define
整个头文件应该在guard define之间

#ifndef lua_h
#define lua_h

#endif
 另外，如果这个头文件可能给c++使用，要加上

#ifdef __cplusplus
extern "C" {
#endif
/*The lines within extern "C" */

#ifdef __cplusplus
}
#endif

3.尽量不要在头文件中暴露数据结构

这样可以用户对你的实现的依赖，也减少了用户的编译时间

typedef struct lua_State lua_State;
LUA_API lua_State *lua_open (void);
LUA_API void       lua_close (lua_State *L);

 可以看到虽然用户会一直使用lua_State,但是并不知道lua_State的结构是什么

从一个使用lua的例子程序可以看出：

#include "lua.h"
#include "lauxlib.h"
#include "lualib.h"

int main(int argc, char *argv[])
{
    lua_State *L = lua_open();
    const char *buf = "var = 100";
    int var ;
    luaopen_base(L);
    luaopen_io(L);
    lua_dostring(L, buf);
    lua_getglobal(L, "var");
    var = lua_tonumber(L, -1);
    lua_close(L);
    return 0;
}

4．函数声明前加XXX_API已利于拓展

 Lua的例子

#ifndef LUA_API

#define LUA_API              extern

#endif

LUA_API lua_State *lua_open (void);

如果定义了LUA_API就是给LUA内部使用的

如果没定义LUA_API就是for user 的

 写Window dll程序经常会用到

#ifdef DLLTEST_EXPORTS

#define DLLTEST_API __declspec(dllexport)

#else

#define DLLTEST_API __declspec(dllimport)

#endif

5.宏的定义

尽量使用括号来包住所定义的对象

#define LUA_TNONE       (-1)

#define lua_register(L,n,f) \

       (lua_pushstring(L, n), \

        lua_pushcfunction(L, f), \

        lua_settable(L, LUA_GLOBALSINDEX))

6.目录结构

一般应该使用一个单独的include目录来包含要发布的头文件，但不应该把内部使用的头文件包含进去。

Lua  的 include目录只包含了三个头文件

lauxlib.h , lua.h, lualib.h

非常简洁