Domande taggate «code-documentation»

codestyle; mettere javadoc prima o dopo l'annotazione?

So che non è il problema più vitale, ma mi sono appena reso conto che posso inserire il blocco di commenti javadoc prima o dopo l'annotazione. Cosa vorremmo adottare come standard di codifica? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired …

184 java coding-style annotations javadoc code-documentation

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 tipo di stringa in jsdoc con valori possibili limitati

Sto avendo una funzione che accetta un parametro stringa. Questo parametro può avere solo uno dei pochi valori possibili definiti. Qual è il modo migliore per documentare lo stesso? ShapeType dovrebbe essere definito come enum o TypeDef o qualcos'altro? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" …

96 google-closure-compiler google-closure jsdoc code-documentation

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.