如何写出专业的C头文件

启_明_星 2010-04-09

展开全文

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

1.License AgreementBSD爱好者乐园7gq)ocw't-G
License Agreement应该加在每个头文件的顶部。BSD爱好者乐园3B FHP#~(~
Lua Sample:BSD爱好者乐园)]6E u2p:se
BSD爱好者乐园#ab*JguM!Mx K

T9Q^6RI1_/*
3?"g"X@ KG?5Cr** $Id: lua.h,v 1.175b 2003/03/18 12:31:39 roberto Exp $
xas;` Oh** Lua - An Extensible Extension Language
AK1|p5^7?e5|b~** Tecgraf: Computer Graphics Technology Group, PUC-Rio, Brazil
!J!yqJEq4f(F~z3L**http://www. mailto:info@BSD爱好者乐园:| YN4r'|Et
** See Copyright Notice at the end of this fileBSD爱好者乐园0@ O"J#fYX
*/
;m:cy"L?N[(g,u BSD爱好者乐园E p0~.p1Q@ h*}

2.guard defineBSD爱好者乐园v Uyv'W \{}b g
整个头文件应该在guard define之间BSD爱好者乐园 @K*PPk}Y

)j}8v$qmC8dBSD爱好者乐园x }:eo$E*V"j
#ifndef lua_hBSD爱好者乐园+c3Q:LMT/G
#define lua_h

#endif
VF;hL6[F2J? 另外，如果这个头文件可能给c++使用，要加上

;L1D'lt?y8qd#ifdef __cplusplus
+[Q Eo.w/X)Mextern "C" {
qU.v$X-^I D2Q#endifBSD爱好者乐园5Xk"dB:Cn}R pn
/*The lines within extern "C" */

BF\+`-vh_+w/m#ifdef __cplusplusBSD爱好者乐园 IC|ox$V F2_
}
:[~8ip6|$S!V4GY#endifBSD爱好者乐园.\.jH9f2SK

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

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

2T)JE s,Q#\(m
F/y)W \v._typedef struct lua_State lua_State;
6tcR/T zu?cn,Y)^LUA_API lua_State *lua_open (void);BSD爱好者乐园X5`:U-P&yL
LUA_API void lua_close (lua_State *L);BSD爱好者乐园7C2l8m1f)goa6g

P|6n9L0iQ[2I,M 可以看到虽然用户会一直使用lua_State,但是并不知道lua_State的结构是什么BSD 爱好者乐园}9n2f!T.E_O

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

Z?Y)Adeo~ BSD爱好者乐园a|uP[6V&R)D1Oy
#include "lua.h"
ERkvz _$di"[#include "lauxlib.h"
n1_'D&@ROv[+S~mt#include "lualib.h"BSD爱好者乐园Q3w&n LG+P

3u[4Q!d!Gd BSD爱好者乐园z k$O8g$W
int main(int argc, char *argv[])
w8rKz5vU7r{BSD爱好者乐园U} m Xn"|xK?`
    lua_State *L = lua_open();
9e/]q"t6g|a"hc%?    const char *buf = "var = 100";BSD爱好者乐园` F3M[Z~ ?
    int var ;BSD爱好者乐园 b[ R9Oy9EG6g
    luaopen_base(L);BSD 爱好者乐园MlN.z~z YR
    luaopen_io(L);BSD爱好者乐园 2{6L)T?iUe2nu2{tk
    lua_dostring(L, buf);BSD爱好者乐园p0P"yL#u?W$S2s
    lua_getglobal(L, "var");
    var = lua_tonumber(L, -1);
5}l`1i+yqw J    lua_close(L);BSD爱好者乐园}4@I2][7a
    return 0;
{9iF \'nOL,W}