Tout d'abord, je ne demande pas comment générer de la documentation à partir d'une source PHP. C'est assez facile avec des bibliothèques comme Doxygen ou PHPDocumentor. Ce que je cherche est un moyen de générer automatiquement des stubs de commentaires basés sur phpdoc en ligne pour les classes, les méthodes, les propriétés, etc. Existe-t-il des bibliothèques préexistantes qui peuvent le faire? J'ai fait un peu de recherche et n'ai rien trouvé.Génération de document INLINE automatique
Je demande seulement parce que j'ai une démangeaison que je veux gratter en écrivant la mienne. J'ai tendance à dépenser des HEURES à la fois en générant du code, en économisant de la documentation comme une dernière étape (je sais, je devrais vraiment le faire comme je vais). Le problème est, même en réalisant l'importance de la documentation en ligne, après 8 heures de codage et d'écriture d'une douzaine de classes avec des dizaines de méthodes et de propriétés, il est un peu rebutant de devoir s'arrêter et de commencer à écrire.
De toute évidence, je ne peux pas créer de documentation complète automatiquement. Des choses comme des descriptions verbeuses de classes, de propriétés et de méthodes doivent être typées à la main. Mais, en utilisant la réflexion, je peux facilement dériver suffisamment d'informations pour créer des stubs de commentaires avec des espaces réservés de type fill-in-the-blank.
Si quelqu'un peut m'aider dans la recherche d'une solution comme celle-ci, AWESOME. Sinon, je vais créer un nouveau référentiel Github et apporter quelque chose d'utile à la communauté. :)
Un certain nombre d'IDE (tels que Eclipse) ont une fonction qui peut générer les stubs PHPDoc pour vous –
+1 Oui, je suis en train de chercher un moyen de le faire par programmation. Fondamentalement, exécutez-le à partir de la ligne de commande et spécifiez un répertoire (+ filtres) pour parcourir et documenter. Je sais qu'Eclipse fait cela, mais, malheureusement, j'utilise Netbeans et je n'arrive pas à trouver cette fonctionnalité. De toute façon, ce serait un petit projet amusant. :) –
duplication possible de [Un outil pour ajouter et compléter la documentation de code source PHP] (http://stackoverflow.com/questions/1936376/a-tool-to-add-and-complete-php-source-code-documentation –