32 votes

Comment lister les modules/classes/constantes/méthodes non documentés avec yardoc ?

J'ai une petite bibliothèque de code que je documente à l'aide de JARDIN . Lorsque j'exécute le programme yardoc me dit-elle :

Files:          40
Modules:        14 (    0 undocumented)
Classes:        39 (    0 undocumented)
Constants:      21 (    4 undocumented)
Methods:       239 (   31 undocumented)
 88.82% documented

Au lieu de parcourir tout mon code pour trouver les constantes et méthodes non documentées, je veux qu'il liste simplement les éléments non documentés. Quelqu'un sait-il comment faire ?

38voto

Vasiliy Ermolovich Points 14719

Vous pouvez dresser une liste spécifique de tous les objets non documentés (et de l'emplacement de leurs fichiers) à l'aide de la commande --list-undoc option.

yard stats --list-undoc

ou même

yard --list-undoc

22voto

postmodern Points 181

Cela m'a également troublé. Les --list-undoc est en fait définie dans le cadre de l'option stats commande. De plus, la commande est yard plutôt que yardoc qui est l'abréviation de yard doc .

yard stats --list-undoc

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X