Use doxygen to create C code documentation

Source: Internet
Author: User
Tags doxygen
Use doxygen to create C code documentation C code annotation style conventions
  1. Line comment

       
       
    1. /*!
    2. *
    3. * Here is the comment
    4. *
    5. */
  2. Intra-row comment

       
       
    1. <Code here> /*! Note */
  3. Doxygen macro name
    It can be '\' or '@' followed by a macro name. For example:
    \briefOr@briefA brief description
    In the HTML generated by doxygen, the overview information is displayed in the previous section. This information has"More", Click to jump to detailed instructions.

  4. Macro name

  5. Macro name
  6. Macro name
  7. Macro name
  8. Macro name
  9. Macro name
  10. Macro name
  11. Macro name
  12. Macro name
  13. Macro name
  14. Macro name
  15. Macro name
  16. Macro name
  17. Macro name
  18. Macro name
  19. Macro name
  20. Macro name
  21. Macro name
  22. Macro name
  23. Macro name
  24. Macro name
  25. Macro name
  26. Macro name
  27. Macro name
  28. Macro name
  29. Macro name


From Weizhi note (wiz)

Use doxygen to create C code documentation

Related Article

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.