这里覆盖了C措辞标准库中的所有函数,给出了每个函数的先容并且都给出了详细的用法示例,比如:

只不过都是英文的解释,可见英文的主要性。

另一种方法是,找一些离线的文档,网上有不少人整理了一些离线的文档,比如.chm格式(已编译的帮助文件)的文档:

php文档chm这个神器可以提取你代码中的症结信息生成技巧文档 PHP

里面大概是这样子的:

也可以很方便的查找每个函数的用法,但是,这里面的不是很全,以是查找C标准库函数还是建议到http://www.cplusplus.com上面去查找。

本文分享的重点便是.chm文件的制作。
最近须要对自己的一些代码做一些整理,创造整理成.chm文件是个不错的选择,.chm文件可以根据我们的代码天生,下面把天生.chm文件的方法分享给大家。

二、制作.chm文件的工具

须要三个工具:doxygen安装包、graphviz安装包、htmlhelp安装包。
个中doxygen是一种开源跨平台的文档系统,doxygen可以从一套归档源文件开始,天生HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。

doxygen可以天生好几种格式的文档,要天生.chm格式的手册就必须安装htmlhelp,要天生关系图必须安装依graphviz。
这个个工具的获取方法:

1、方法一:官网下载

(1)doxygen安装包:

http://www.doxygen.nl/download.html

(2)graphviz安装包:

http://www.graphviz.org/

(3)htmlhelp安装包:

https://www.microsoft.com/en-us/download/details.aspx?id=21138

2、方法二:百度云盘下载

链接:https://pan.baidu.com/s/1gsJxkGsoO0ncy0GGM6PyQw 提取码:3754

若链接失落效可联系我。

下载的都是.exe格式的可实行文件,就按平时安装软件的方法安装件就可以了。
但是,须要记住graphviz与htmlhelp的安装路径,后面利用Doxygen时须要用到。

三、Doxygen根据代码天生.chm的机制

Doxygen可以根据固定格式的代码注释天生相对应的.chm格式的手册。
支持的措辞有好多种,如C/C++/C#/Objective-C/PHP/Java等。
这里紧张是分享C措辞,Doxygen可以识别的固定格式注释有以下几种:

这里,我利用第一种,如:

/ 函数功能:字符串逆序函数 @param src_str:字符串 @param str_len:字符串长度 @return 逆序之后得到的字符串 / char Str_ReverseOrder(char src_str,int str_len){char dst_str = src_str;char temp;printf("Method 1!\n");for(int i=0;i<str_len/2;i++){temp = src_str[i];src_str[i] = src_str[str_len-i-1]; src_str[str_len-i-1] = temp;}return (char)dst_str;}

所有的函数都利用这样统一格式的注释。

四、Doxygen天生.chm文件的方法1、设置工程事情目录

2、设置编程措辞

3、设置输出文件格式

4、设置天生的关系表

5、输出的措辞、编码

6、设置一些构建的选择项

7、设置输入文件的编码

8、设置是否在.chm中天生源码以供预览

9、设置HTML选项

10、设置Dot选项

11、运行天生.chm文件

12、保存工程文件

五、终极成果效果图

下面看一下我们天生的.chm文件:

以上便是本次的分享,感谢阅读!