网站首页 > 教程文章 正文
一、前言
以前,我们学C语言的时候,多多少少都查过一些标准库函数吧。这里介绍查找C语言的标准库函数的两种方法:一种方法是直接到http://www.cplusplus.com这个网站上去查看:
这里覆盖了C语言标准库中的所有函数,给出了每个函数的介绍并且都给出了具体的用法示例,比如:
只不过都是英文的说明,可见英文的重要性。
另一种方法是,找一些离线的文档,网上有不少人整理了一些离线的文档,比如.chm格式(已编译的帮助文件)的文档:
里面大概是这样子的:
也可以很方便的查找每个函数的用法,但是,这里面的不是很全,所以查找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文件:
以上就是本次的分享,感谢阅读!
猜你喜欢
- 2025-01-13 一个前端代码注释的小技巧,让领导开心的不得了~
- 2025-01-13 Java注解最全详解(超级详细)
- 2025-01-13 Golang 无注解原因
- 2025-01-13 集成开发环境Android Studio整合Gemini:可生成、补全代码
- 2025-01-13 解析AI智能编程助手CodeGeeX与通义灵码使用
- 2025-01-13 Java注解详解以及如何实现自定义注解
- 2025-01-13 推荐一个代码生成文档的工具mintlify
- 2025-01-13 Idea超实用的自定义注释模板,一键注释,简化开发
- 2025-01-13 学会Word题注+查找和替换功能,1000张图片自动编号,10秒搞定
- 2025-01-13 Go 自动生成 Swagger API 文档的详细步骤
- 最近发表
-
- esbuild:一款快 10-100 倍的 JS 打包 / 压缩工具
- ESM 内功心法:化解 require 中的夺命一击!
- webpack中exportsFields和mainFields的用法
- Rust cargo 命令行工具使用教程(rust指令怎么用)
- Axios CORS 问题处理(axios设置cors)
- Nodejs 第七十四章(微服务)(nodejs微服务是什么)
- 11个web前端开发人员必备的在线工具,功能强大,值得收藏
- 新一代Python包管理工具来了(python community包)
- 开发者提示工程实用指南(工程师开发使用中)
- 软件构建工具汇总与选择指南(软件构造工具)
- 标签列表
-
- location.href (44)
- document.ready (36)
- git checkout -b (34)
- 跃点数 (35)
- 阿里云镜像地址 (33)
- qt qmessagebox (36)
- md5 sha1 (32)
- mybatis plus page (35)
- semaphore 使用详解 (32)
- update from 语句 (32)
- vue @scroll (38)
- 堆栈区别 (33)
- 在线子域名爆破 (32)
- 什么是容器 (33)
- sha1 md5 (33)
- navicat导出数据 (34)
- 阿里云acp考试 (33)
- 阿里云 nacos (34)
- redhat官网下载镜像 (36)
- srs服务器 (33)
- pico开发者 (33)
- https的端口号 (34)
- vscode更改主题 (35)
- 阿里云资源池 (34)
- os.path.join (33)