Instrumente pentru documentaţie automatizată
Doxygen este cel mai cunoscut tool care generează documentaţie şi referinţe API similar cu javadoc.Este folosit pentru mai mult comentariile oficiale și nu este neapărat folosit pentru toate comentariile din cod.
Poate produce documentație de calitate, care dacă este foarte bine redactată poate face parte din documentaţia oficială a unui produs, şi care poate ajunge chiar la clienţi. Documentaţia rezultată este utilizată mai ales pentru faza de design unde toate variabilele globale şi funcţiile globale API (şi nu numai) sunt descrise în detaliu. Poate produce html, pdf, chm, rtf, xml, etc. Pentru mai multe detalii vezi aici http://www.doxygen.org
Exemplu
Doxygen function header:
/** \brief Returns the value of the specified port
**
** This function reads and returns the value of the
** port specified by the parameter \p PortId.
**
** \pre The \p PortId is valid (only checked in
** development mode)
**
** \param[in] PortId The numeric id of the port
**
** \retval The value of the port, range depends on the
** width of the port 0 .. 2ˆPortWidth-1
** \retval 0 if \p PortId is invalid
** (development mode only) */
extern PortLevelType ReadPort (PortType PortId);
Opinia mea
Părerea mea este să folosiţi cu încredere acest tool care vă poate scuti de o grămadă de muncă.Alternative pentru acest tool găsiţi aici .