Different Comment Styles [solved]



  • Hi,

    I started to document my code using Doxygen. Doxygens manual says there are two different ways to mark a commentblock to be documentated. One started with //* (JavaDoc style), the other with //! (Qt style).
    If I type //* above my setReal-Method of my CplxNum-Class in Qt-Creator it will be auto-completed to

    @
    /**

    • @brief CplxNum::setReal
    • @param real
      */
      @

    and //! is autocompleted to

    @
    /*!

    • \brief CplxNum::setReal
    • \param real
      */
      @

    I noticed that there is a minor different in these completions (@param -> \param, @brief -> \brief). I guess that this is a Qt specific thing, because it doesn't know that I want to use Doxygen for documentation.

    What is the difference between these two comment styles and which one is recommended?

    Thanks,
    Nobody-86


  • Moderators

    Hi,

    The differences are purely cosmetic. Doxygen accepts both JavaDoc-style and Qt-style comments, so you can choose whichever you want.

    In fact, Doxygen began as a tool to generate documentation for Qt code: http://www.stack.nl/~dimitri/doxygen/manual/features.html



  • Hi JKSH,

    thanks for your reply. Good to know that there is no difference between these styles.

    -> solved


Log in to reply
 

Looks like your connection to Qt Forum was lost, please wait while we try to reconnect.