能否将cppreference.com文档(含离线版)集成到CLion文档查看器?
如何将cppreference文档集成到CLion的文档查看器中?
当然没问题!CLion完全支持把cppreference的文档(不管是在线版还是离线包)集成到它的快速文档查看器和Doxygen相关工具里,我这就给你一步步讲清楚怎么操作:
在线集成cppreference文档
- 打开CLion,进入
File > Settings(Windows/Linux系统)或者CLion > Settings(Mac系统)。 - 在设置窗口里,找到
Tools > External Documentation选项。 - 点击界面上的
+号,添加一个新的外部文档配置:- 名称随便填,比如
cppreference 在线版就行 - URL模板填
https://en.cppreference.com/w/cpp/%s(英文原版),如果习惯看中文文档,就用https://zh.cppreference.com/w/cpp/%s - 在
Patterns区域,添加匹配规则,比如:- 匹配C++函数:
cpp:function: - 匹配C++类:
cpp:class: - 嫌麻烦的话直接填
*,就能匹配所有类型的标准库元素了
- 匹配C++函数:
- 名称随便填,比如
- 保存设置后,当你在代码里选中
tan()这类函数,按下Ctrl+Q(Windows/Linux)或者F1(Mac)打开快速文档,就能看到跳转按钮,点一下直接跳转到cppreference的在线文档页面。
离线集成cppreference文档
如果需要离线访问,先去cppreference官网下载对应的离线HTML包(不用联网也能看的那种),然后按下面步骤来:
- 同样进入
File > Settings > Tools > External Documentation - 新增一个配置,名称比如叫
cppreference 离线版 - URL模板填你本地离线包的路径,格式要对:
- Windows系统:
file:///C:/你的离线包路径/docs/cpp/%s.html - Linux/Mac系统:
file:///home/你的用户名/离线包路径/docs/cpp/%s.html
- Windows系统:
- 同样配置好Patterns(和在线版一样就行)
- 保存后,就算断网了,打开快速文档也能直接查看本地的cppreference内容。
集成到基于Doxygen的文档查看器
CLion的Doxygen查看器也能关联cppreference的内容,操作如下:
- 先确保你已经安装了Doxygen(去官网下载安装就行)
- 进入
File > Settings > Build, Execution, Deployment > Doxygen,在Doxygen executable里指定你的Doxygen安装路径 - 回到
Tools > External Documentation,确保之前添加的cppreference配置是启用状态 - 这样一来,当你查看代码里的Doxygen注释时,如果注释里提到了标准库的函数或类,CLion会自动关联到cppreference的文档,你可以直接跳转查看。
内容的提问来源于stack exchange,提问作者Sebastian
相关产品推荐
相关产品推荐

