Вопросы с тегом «code-documentation»

Я знаю, что это не самая насущная проблема, но я только что понял, что могу поставить блок комментариев Javadoc до или после аннотации. Что бы мы хотели принять в качестве стандарта кодирования? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** …

184 java  coding-style  annotations  javadoc  code-documentation 

Как я могу сообщить 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 an …

156 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

У меня есть функция, которая принимает один строковый параметр. Этот параметр может иметь только одно из нескольких определенных возможных значений. Как лучше всего задокументировать то же самое? Следует ли определять shapeType как enum, TypeDef или что-то еще? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"... …

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