Commentaire en vue de documenter
Bonjour à toutes et à tous,
Existe t'il un logiciel, une solution capable de "récupérer" les commentaires d'une page web afin de générer une doc ?
Existe t'il une sorte de dictionnaire du formalisme à adopter selon les languages ?
des règles strictes ou recommandées en terme de commentaires ?
J'ai vu qu'il y avait un certain formalisme pour commenter ses fonctions en php par exemple :
(mais ce n'est que pour les fonctions..)
Code:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| /**
* Description for dateDiff
* @private
* @method dateDiff
* @param {Object} $date1
* @param {Object} $date2
* @return {Object} description
*/
function dateDiff($date1, $date2){
$datetime1 = date_create($date1);
$datetime2 = date_create($date2);
$interval = date_diff($datetime1, $datetime2);
$interval= $interval->format('%a j')."<br>".$interval->format('%hh %im %ss');
return $interval;
} |
J'ai une page WEB PHP qui contient à la fois, du HTML du PHP, du CSS et du JavaScript.
Pour le PHP et le JavaScript, je commentes mes fonctions, mes classes...
J'aimerais que ces infos soient automatiquement récupérées pour générer une doc.
J'ai bien trouvé "PhpDocument" mais qui ne fonctionne, comme son nom l'indique, que avec le php.
Si quelqu'un à une idée, une suggestion, des liens.. je suis preneur, autant sur la récupération des commentaires que sur leur formalisme
Par avance, merci
Cdlt
David
