Questions marquées «documentation»

La documentation du logiciel est un texte écrit qui accompagne les logiciels informatiques. Il explique comment le logiciel fonctionne, comment l'installer, comment l'utiliser et d'autres ressources d'aide.






17
Les commentaires de TODO ont-ils un sens? [fermé]
Je travaille sur un assez gros projet et j'ai la tâche de faire quelques traductions. Il y avait des tonnes d'étiquettes qui n'ont pas été traduites et alors que je cherchais dans le code, j'ai trouvé ce petit morceau de code. //TODO translations Cela m'a fait réfléchir sur le sens …

13
Le code commenté peut-il être une documentation précieuse?
J'ai écrit le code suivant: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.persist(boutique); } else { boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); //boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.merge(boutique); } Il y a une ligne commentée ici. Mais je pense que cela rend le …



15
Je vais quitter mon emploi à cause de notre plate-forme: comment puis-je laisser une explication productive à ce sujet? [fermé]
Je prévois de quitter mon emploi actuel parce que nous sommes obligés d'utiliser Blub , avec un framework d'entreprise Blub et un serveur Web de niveau Blub, sur un hébergement mutualisé médiocre. Mes collègues sont sympathiques et mon patron est un propriétaire de petite entreprise moyen. Je veux partir entièrement …


12
Existe-t-il une raison logique de générer automatiquement de la documentation de code? [fermé]
La génération automatique de documentation peut être réalisée avec divers outils, GhostDoc étant l’un des plus importants. Cependant, par définition, tout ce qu’il génère est redondant. Il examine les noms de méthodes, de classes, etc. et génère un anglais qui pourrait les expliquer plus verbalement. Dans le meilleur des cas, …




En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.