Questions marquées «documentation-generation»

Swift prend-il en charge la génération de documentation?

De nombreuses langues prennent en charge les commentaires de documentation pour permettre à un générateur (comme javadocou doxygen ) de générer de la documentation de code en analysant ce même code. Swift a-t-il une fonctionnalité de commentaire de documentation de type comme celle-ci?

238 swift documentation-generation

JSDoc: structure de l'objet de retour

Comment puis-je informer JSDoc de la structure d'un objet renvoyé. J'ai trouvé la @return {{field1: type, field2: type, ...}} descriptionsyntaxe et l' ai essayé: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery …

144 javascript documentation-generation jsdoc code-documentation jsdoc3

Comment documenter une méthode avec des paramètres?

Comment documenter des méthodes avec des paramètres en utilisant les chaînes de documentation de Python? EDIT: PEP 257 donne cet exemple: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and …

139 python documentation documentation-generation

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.