What is Doxygen style comments?

What is Doxygen style comments?

Doxygen (/ˈdɒksidʒən/ DOK-see-jən) is a documentation generator and static analysis tool for software source trees. When used as a documentation generator, Doxygen extracts information from specially-formatted comments within the code.

How do you make a Doxygen comment?

Adding Documentation Comments Code::Blocks inserts a Doxygen block comment starting with /**. Doxygen knows that this comment belongs to the function definition that immediately follows. Doxygen keywords start with a (backslash). The brief keyword flags the brief description of the function.

Where do Doxygen comments go?

Put the documentation where people will read and write it as they are using and working on the code. Class comments go in front of classes, method comments in front of methods. That is the best way to make sure things are maintained.

How do I document with Doxygen?

In order to generate doxygen based documentation, you need to follow four steps:

1. have the doxygen executable installed on your computer (this is already done on our DESY machines)
2. document your code.
3. create a configuration file.
4. run doxygen to create the documentation (HTML or LaTeX based).

How do you style Doxygen?

Doxygen Style Guide

1. Use the ‘@cmd’ form for all doxygen commands (do not use ‘\cmd’ ).
2. Use symbol names such that Doxygen automatically creates links:
3. Use good Doxygen mark-up:
4. Two spaces should be used when nesting lists; do not use ‘\t’ in lists.
5. Code examples provided in documentation must conform to the Style Guide.

How do you write a good Javadoc comment?

Javadoc coding standard

1. Write Javadoc to be read as source code.
2. Public and protected.
3. Use the standard style for the Javadoc comment.
4. Use simple HTML tags, not valid XHTML.
5. Use a single

   tag between paragraphs.

6. Use a single
7. tag for items in a list.
8. Define a punchy first sentence.