你可以运行Doxygen http://en.wikipedia.org/wiki/Doxygen生成基于 HTML 的源浏览器。这不需要用 Doxygen 风格的文档来注释代码。它适用于多种语言,包括C++, Java, and Markdown (.md
文件转到“相关页面”)。
这是从命令行配置和启动 Doxygen 的方法(在 Linux 上测试)...
## basic
echo -e "SOURCE_BROWSER=YES\n EXTRACT_ALL=YES\n RECURSIVE=YES\n" |doxygen -
xdg-open html/index.html
or
## include diagrams and non-public content -- and launch browser immediately
echo -e "HAVE_DOT=YES\n CALL_GRAPH=YES\n CALLER_GRAPH=YES\n SOURCE_BROWSER=YES\n EXTRACT_ALL=YES\n EXTRACT_PRIVATE=YES\n EXTRACT_STATIC=YES\n RECURSIVE=YES\n SEPARATE_MEMBER_PAGES=YES\n GENERATE_LATEX=NO\n EXCLUDE_SYMLINKS=YES" |doxygen - && chromium-browser --new-window html/index.html
有一个配套程序叫做多西巫师 http://www.doxygen.nl/manual/doxywizard_usage.html它允许您浏览可用于自定义生成的 HTML 的许多配置选项。或者,您可以运行doxygen -g
创建初始配置文件(其中包括详细提示)。
我建议使用以下非默认选项来生成源浏览器:
SOURCE_BROWSER=YES ## display source code
EXTRACT_ALL=YES ## display all items (not just "documented" ones)
RECURSIVE=YES ## include source found in subdirectories
SEPARATE_MEMBER_PAGES=YES ## optional -- each class member has its own page
一旦您打开主网页,您就可以浏览到感兴趣的来源(或使用搜索功能)。来源与相关声明的可点击链接进行交叉引用。
我已经多次遇到这个问题:doxygen 可以创建很长的文件名,Linux 加密的主目录有一个限制为 143 个字符 https://askubuntu.com/q/728465/11522。要解决这个问题,您可能需要编写html
您家之外的文件夹。
一个快速而肮脏的解决方案是链接html
到一个文件夹/tmp
or /dev/shm
——也许还有chmod
提高数据安全性的权限。