Lors de l'exécution de phpdoc sur un projet CodeIgniter, quels dossiers doivent être inclus?

Question

Lors de mon premier essai, j'ai uniquement inclus le système/l'application/les modèles, le système/l'application/les contrôleurs, le système/l'application/les assistants et le système/l'application/les bibliothèques. J'ai choisi ces dossiers parce que je pense que ces dossiers contiennent le code que vous voulez être correctement documenté pour la future référence. Quels autres dossiers pensez-vous devraient être inclus?

Answer 1

Pour être minutieux en termes de votre propre code. Je recommande les dossiers et le cas échéant, ont annotée suivantes:

1. système /application/controllers
2. système /application/Aides
3. système /application/crochets - Ne pas manquer cette sortie! Chaque fois que vous modifiez/étendre le noyau de CI, vous devez documenter certainement
4. système /application/modèles
5. système /application/bibliothèques
6. système /application/langue - Cela peut venir dans la mise en œuvre utile lorsque la localisation
système
7. /plugins - comme vous y compris les bibliothèques, il serait logique d'inclure des plugins externes utilisés et

Answer 2

Je pense que vous l'avez couvert. Le reste est probablement déjà documenté dans la documentation de CodeIgniter.

Si vous ajoutez un plugin/une bibliothèque/tout ce qui doit être en dehors de ces dossiers, veillez à les ajouter ultérieurement.