Запитання з тегом «code-documentation»

Я знаю, що це не найважливіша з питань, але я просто зрозумів, що можу поставити блок коментарів javadoc до або після анотації. Що б ми хотіли прийняти як стандарт кодування? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** * This …

183 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 …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

У мене є функція, яка приймає один параметр рядка. Цей параметр може мати лише одне з декількох визначених можливих значень. Який найкращий спосіб документувати те саме? Чи слід shapeType визначати як enum, TypeDef чи щось інше? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"... this.type …

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