Domande taggate «documentation-generation»

Swift ha il supporto per la generazione di documentazione?

Molte lingue supportano i commenti della documentazione per consentire a un generatore (like javadoco doxygen ) di generare la documentazione del codice analizzando lo stesso codice. Swift ha qualche tipo di commento di documentazione come questo?

238 swift documentation-generation

JSDoc: restituisce la struttura dell'oggetto

Come posso comunicare a JSDoc la struttura di un oggetto che viene restituito. Ho trovato la @return {{field1: type, field2: type, ...}} descriptionsintassi e l'ho provata: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or …

144 javascript documentation-generation jsdoc code-documentation jsdoc3

Come documentare un metodo con i parametri?

Come documentare metodi con parametri usando le stringhe di documentazione di Python? EDIT: PEP 257 fornisce questo esempio: 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 real == 0.0: …

139 python documentation documentation-generation

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.

Licensed under cc by-sa 3.0 with attribution required.