How to document your code

Posted by Chen22 on 2021-03-29

Recently, I need to document my project code. It’s chanllenge since I’ve never done that before.

Long story short, finnaly, we pick up Doxygen. It can documenting the code. See Doxygen for more deails. It’s quite easy to generate API documentation with Doxygen, but it can only produce documents like html, xml. I need markdown documents which can be publish as gitbook. So I choose doxybook2. It can convert the xml to markdown.