Запитання з тегом «documentation-generation»

Багато мов підтримують коментарі документації, щоб дозволити генератору (наприклад, javadocабо доксигену ) генерувати кодову документацію шляхом аналізу того самого коду. Чи має Swift якусь функцію коментування документації типу такої?

238 swift  documentation-generation 

Як я можу розповісти JSDoc про структуру об'єкта, який повертається. Я знайшов @return {{field1: type, field2: type, ...}} descriptionсинтаксис і спробував: /** * 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 event wrapping such …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

Як документувати методи з параметрами за допомогою рядків документації Python? EDIT: PEP 257 дає такий приклад: 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: return complex_zero …

139 python  documentation  documentation-generation 

Мені потрібно впровадити рішення щодо створення документації для мого робочого місця і звузило його до трьох, згаданих у назві. Мені вдалося знайти дуже мало інформації на шляху формалізованого порівняння між цими рішеннями, і я сподіваюся, що ті з вас, хто має досвід в одному чи кількох із перерахованих вище, можуть …

74 doxygen  documentation-generation  headerdoc  appledoc