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?Lors de l'exécution de phpdoc sur un projet CodeIgniter, quels dossiers doivent être inclus?
2
A
Répondre
5
Pour être minutieux en termes de votre propre code. Je recommande les dossiers et le cas échéant, ont annotée suivantes:
- système /application/controllers
- système /application/Aides
- système /application/crochets - Ne pas manquer cette sortie! Chaque fois que vous modifiez/étendre le noyau de CI, vous devez documenter certainement
- système /application/modèles
- système /application/bibliothèques
- système /application/langue - Cela peut venir dans la mise en œuvre utile lorsque la localisation système
- /plugins - comme vous y compris les bibliothèques, il serait logique d'inclure des plugins externes utilisés et
1
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.
Questions connexes
- 1. Quels fichiers doivent être inclus sous VSS 6.0
- 2. Quels champs doivent être inclus dans une table de base de données pour l'authentification de l'utilisateur?
- 3. Quels PEP doivent être lus?
- 4. Quels fichiers de projet ASP.NET MVC doivent être conservés dans un référentiel?
- 5. Quels fichiers de projet ne doivent pas être vérifiés dans SVN
- 6. Quels mixups de lettres et de nombres doivent être considérés?
- 7. Quels fichiers ne doivent être que chez Root?
- 8. Les exceptions doivent être dans un projet différent
- 9. Quels fichiers .net doivent être exclus du contrôle de source?
- 10. Quels fichiers d'un projet VDRS Database Edition GDR R2 doivent être exclus du contrôle de code source?
- 11. Quels paramètres doivent être évalués de manière approfondie dans SQL Server?
- 12. Comment gérer un projet SVN réparti sur plusieurs dossiers?
- 13. Les fichiers cs doivent-ils être déployés lors de la publication d'une application ASP.Net MVC?
- 14. Les ensembles d'interopérabilité doivent-ils être signés?
- 15. Quels caractères doivent être échappés pour empêcher les injections (My) SQL?
- 16. quels caractères doivent être échappés dans les paramètres de chaîne sql
- 17. Les exceptions doivent-elles être placées dans un paquet séparé?
- 18. Extensibilité de Visual Studio: ajout de dossiers existants à un projet
- 19. Comment puis-je exclure certains dossiers de mon projet Eclipse?
- 20. Comment Vista décide-t-il quels programmes doivent être fermés lorsque la mémoire est insuffisante?
- 21. Dossiers d'installation de Windows
- 22. En utilisant Mercurial, comment puis-je voir quels changements doivent encore être poussés?
- 23. Codeigniter: $ query-> free_result() lors de l'utilisation de l'enregistrement actif?
- 24. Les dossiers d'une solution doivent-ils correspondre à l'espace de noms?
- 25. Les onglets jquery doivent-ils être à l'intérieur de document.ready?
- 26. En-têtes précompilés MSVC: Quels fichiers doivent # inclure "stdafx.h"?
- 27. Combien de tables doivent être placées sur le même schéma de partition?
- 28. Pourquoi les tables doivent-elles être réparées?
- 29. Les nombres doivent-ils être localisés?
- 30. Où les éléments doivent-ils utiliser le format MVC à l'aide de CodeIgniter