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

184
codestyle; поставить Javadoc до или после аннотации?

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

96
Как задокументировать строковый тип в jsdoc с ограниченными возможными значениями

У меня есть функция, которая принимает один строковый параметр. Этот параметр может иметь только одно из нескольких определенных возможных значений. Как лучше всего задокументировать то же самое? Следует ли определять shapeType как enum, TypeDef или что-то еще? Shape.prototype.create = function...