可以考虑使用 Doxygen
#265
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
{{ message }}
-
可以考虑使用 Doxygen 这类工具结合 Github Actions 来持续自动生成代码的文档, 应该会对开发者和使用者带来不少帮助.
目前有不少项目利用该工具生成文档, 个人使用感受挺好的.
不过目前完全没有这方面的注释, 如果要实现的话工作量可能不小.
如果每个类和个别函数能有一个简短的简介, 应该可以使代码阅读变得更加简单(即使只阅读源码).
Beta Was this translation helpful? Give feedback.
All reactions