17 lines
874 B
TeX
17 lines
874 B
TeX
|
\begin{frame}[containsverbatim]
|
||
|
|
\frametitle{\secname}
|
||
|
|
\framesubtitle{\subsecname : Les commentaires de documentation}
|
||
|
|
Les commentaires de documentation sont encadrés par les symboles \verb|/**| et \verb|*/|.
|
||
|
|
\vspace{0.5cm}
|
||
|
|
\par
|
||
|
|
On les trouve principalement juste avant une déclaration de fonction, pour expliquer ce que fait cette fonction, le rôle de chaque paramètre, et leurs valeurs possibles,
|
||
|
|
des préconditions, expliquer les valeurs de retour et leur signification, les auteurs de la fonction, les dates de modification de la fonction, \ldots
|
||
|
|
\vspace{0.5cm}
|
||
|
|
\par
|
||
|
|
Ces commentaires sont récupérés de manière automatique par des logiciels comme \emph{Doxygen} afin de générer et formater des documentations au format HTML, notamment.
|
||
|
|
\vspace{0.5cm}
|
||
|
|
\par
|
||
|
|
La syntaxe de ces commentaires est identique à celle de JavaDoc.
|
||
|
|
\end{frame}
|
||
|
|
|