Perguntas com a marcação «code-documentation»

Sei que não é o problema mais importante, mas acabei de perceber que posso colocar o bloco de comentários javadoc antes ou depois da anotação. O que gostaríamos de adotar como um padrão de codificação? /** * This is a javadoc comment before the annotation */ @Component public class MyClass …

184 java  coding-style  annotations  javadoc  code-documentation 

Como posso informar o JSDoc sobre a estrutura de um objeto retornado. Eu encontrei a @return {{field1: type, field2: type, ...}} descriptionsintaxe e tentei: /** * 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 

Estou tendo uma função que aceita um parâmetro de string. Este parâmetro pode ter apenas um dos poucos valores possíveis definidos. Qual é a melhor maneira de documentar o mesmo? O shapeType deve ser definido como enum ou TypeDef ou algo mais? Shape.prototype.create = function (shapeType) { // shapeType can …

101 google-closure-compiler  google-closure  jsdoc  code-documentation