code-documentation
JSDoc: Devolver estructura de objetos
¿Cómo puedo decirle a JSDoc sobre la estructura de un objeto que se devuelve? He encontrado la sintaxis @return {{field1: ty ... y necesito que la gente sepa sobre el objeto que se les devolverá. ¿Es esto posible en JSDoc? Estoy usando JSDoc3.3. 0-beta1.
Nodo de Documentación.js projects [closed]
Actualmente estoy usando JSDoc Toolkit para documentar mi código, pero no encaja del todo, es decir, parece tener dificultad ... jor con Node.js? (Miré brevemente en Natural Docs, JSDuck y breezed sobre bastantes otros que parecían bastante obsoletos...)
¿Es posible combinar dos páginas creadas por SandCastle en una sola página principal?
Para cada clase en el proyecto, SandCastle crea (entre otras) dos páginas:
La página principal, llamada como T_class_full ... étodos, Campos, etc.
¿Hay una manera de fusionar estos dos juntos - con el members page que se añade a la página principal?
Cómo documentar un tipo de cadena en jsdoc con valores posibles limitados
Tengo una función que acepta un parámetro de cadena. Este parámetro solo puede tener uno de los pocos valores posibles defini ... hivos aportados por varios desarrolladores que podrían agregar a los posibles valores de shapeType.
PS: Estoy usando jsdoc3
¿Cuáles Son Las Mejores Prácticas Para Documentar código C # con comentarios XML?
Estoy revisando un nuevo código que acabo de escribir y agregando comentarios NDoc sytle a mis clases y métodos. Espero gener ... sa de moda rápidamente; si pudiera tener algunas buenas reglas para guiarme, podría terminar mis documentos mucho más rápido.