Doxygen is good tool for literally programming. It shouldn't be only a set of standards to write comments, but a powerful tool to write agile documents (I insist that programmers should write documents to describe your idea, but I deny the meaningless documents). Sth to notes: 1. don't abuse the doxygen tags unless you decide the comments should become documents. 2. use dot 3. use verbatim to do more descriptions. 4. use the comments to describe what is the process of a function, eg. /*! * ... */ int f(int a) { /*! for each i between [0, 100): * */ for (int i = 0; i < 100; ++i) { /*! doing the calculation */ caculate(); } } Thus, doxygen can generate the documentation like: for each i between [0, 100): doing the caculation;
doxygen usage
最新推荐文章于 2022-06-22 15:04:51 发布