Perl a-t-il un générateur de Documents Perl? Quelque chose comme Java Docs ou PHP Documenter?
4 Réponses :
Oui, c'est ce qu'on appelle perdoc
vous simplement Écrivez la documentation dans la source, tout comme avec Javadoc.
brièvement, "= élément" est un élément à puces, par exemple Une fonction ou un paramètre "= sur" descend un niveau d'identification "= retour" monte un niveau. Utilisez "= couper" où vous souhaitez revenir au code Perl.
Voici un exemple de ce qu'il pourrait ressembler à: passe simplement votre code Perl via le programme Perldoc pour obtenir la documentation formatée.
Eh bien, c'est très différent de Javadoc ou de phpdoc en ce qui concerne la façon dont vous documentez les choses, mais afaik c'est l'outil de documentation standard.
Je suggérerais vivement de ne jamais utiliser de POD entre le code (entrelacé), car le balisage est vraiment gonflé et servira simplement à obscurcir la navigation et la cohérence du code. Écrivez un code auto-documentant et mettez le gousson au bas du document ci-dessous un __ fin __ étiquette.
Répondre à Evan Carroll - Il s'agit simplement de préférences personnelles - je préfère généralement que la nacelle entrelacée, il est beaucoup plus facile de conserver la documentation à jour et de tout éditeur décent facilitera la tâche de voir ce qui est le code et de la pod.
Vous voulez dire Perldoc ?
Voir aussi cette question de dépassement de pile associée:
[juste pour les googlers] Comme les personnes déjà indiquées, vous effectuez une documentation avec POD (pas les commentaires, les commentaires sont pour les responsables, POD pour la documentation de l'utilisateur). Habituellement, vous ajoutez votre POD au début et à la fin de votre script ou de votre module, et avant chaque méthode), vous pouvez alors utiliser Il y a une nouvelle question sur le formatage du pod qui pourrait également être de votre intérêt
Perl-Documentation-Pod-navigateurs
et celui-ci Comment-plan-i- générer-html-documentation-for-perl-code-commentaires
Et il y avait une autre chose qui parle de faire un pod2html et d'utiliser un fichier CSS pour imiter les pages CPansearch, mais je ne peux pas le trouver maintenant. perdoc votre_module dans la console ou pod2html pour convertir à HTML et parcourir sur un serveur ou utilisez pdoc (il est un peu vieux mais très utile quand vous Voulez-vous avoir un navigateur Web Doc et des liens vers le code sur le Web).
COSSE? Conversion vers ou depuis POD? Les gens écrivent des livres dans POD! Rechercher cpan pour POD! Pood Personnes!
Voici la page Wikipedia sur POD: EN.Wikipedia.org/wiki/plain_old_documentation