preguntar acerca de documentation

Joshua Bloch dans son Java efficace écrit: "Utilisez la balise Javadoc @throws pour documenter chaque exception décochée qui une méthode peut lancer, mais n'utilisez pas le mot-clé throws pour inclure non cochée exceptions dans la déclaration de mé …

J'ai plusieurs projets PHP finis et plus anciens avec beaucoup d'inclusions que je voudrais documenter dans le style javadoc/phpDocumentor. Tout en travaillant manuellement dans chaque fichier et en étant obligé de faire une révision de code à côté …

J'utilise Sphinx pour générer la documentation d'un de mes projets. Dans ce projet, je décris une liste de commandes disponibles dans un fichier yaml qui, une fois chargé, aboutit à un dictionnaire sous la forme {command-name : command-descripti …

J'ai finalement appris Java et je cherche de la documentation pour Java que je peux télécharger et lire hors ligne. Quelque chose comme sun's stuff mais zippé ou en PDF ou CHM. J'utilise Eclipse donc quelque chose qui s'intègre avec ce serait bien. …

J'apprends actuellement Objective-C et j'ai besoin de savoir comment écrire une description de méthode. J'ai beaucoup de difficulté à apprendre à le faire dans Objective-C. Dans Jave nous avons ceci /** < h2 >MethodName</ h2 > < p …

ok j'ai cette phpdoc au-dessus de ma méthode de classe /** * this a function that translates the text * @param string|boolean $lang if string the string given in the parameter will be the language code that will represent the language desired, if …

j'ai un projet django, que j'document à l'aide de repos dans les docstrings de faire ce qui suit: Aide diagloags au sein de l'IDE plus tard pour construire la documentation HTML en utilisant Sphinx ma documentation apparaît correctement dans IDE ( …

je veux préparer une documentation pour une collection de projets, de modules et de bibliothèques dans le domaine de la vision informatique (principalement écrite en C++). Pour ce faire, J'ai consulté la documentation D'OpenCV et comme vous le savez …

J'aimerais utiliser SAML pour permettre aux utilisateurs authentifiés d'un site Web de se connecter à d'autres sites fédérés. En langage d'identification unique, cela signifie que mon site doit devenir un fournisseur D'identité. quelqu'un peut-il m …

J'utilise PHP et JavaScript dans mon projet, que je code entièrement avec netbeans 7.0.1. J'aime vraiment la façon dont netbeans intègre et utilise le style de commentaires JavaDoc, à la fois pour le code PHP et le code JS. maintenant, je veux génér …