Preguntas etiquetadas con code-documentation

Sé que no es el más importante de los problemas, pero me di cuenta de que puedo poner el bloque de comentarios javadoc antes o después de la anotación. ¿Qué nos gustaría adoptar como estándar de codificación? /** * This is a javadoc comment before the annotation */ @Component public …

184 java  coding-style  annotations  javadoc  code-documentation 

¿Cómo puedo decirle a JSDoc sobre la estructura de un objeto que se devuelve? Encontré la @return {{field1: type, field2: type, ...}} descriptionsintaxis y la probé: /** * 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 

Tengo una función que acepta un parámetro de cadena. Este parámetro solo puede tener uno de los pocos valores posibles definidos. ¿Cuál es la mejor forma de documentar lo mismo? ¿Debe shapeType definirse como enum o TypeDef o algo más? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", …

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