code-documentation

Существуют ли какие-либо специальные стандарты или инструменты для документирования директив AngularJS? Мы явно создаем части многоразовой функциональности, поэтому мы должны быть в состоянии передать их интерфейсы разработчикам. Я видел пару вещей: чванство. Мне нравится направление, в котором движется Sw...

как я могу рассказать 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...

для каждого класса в проекте SandCastle создает (среди прочих) две страницы: главная страница, называется как T_class_full_name, с описанием, синтаксисом, иерархией наследования и см. также страница участников, называется AllMembers_T_class_full_name, С конструкторам, методам, полям и т. д. есть ли способ ...

в настоящее время я использую JSDoc Toolkit чтобы документировать мой код, но он не совсем подходит, а именно, он, похоже, борется с описанием пространств имен должным образом. Скажем, у вас есть два простых класса в каждом их файлов: lib/database/foo.js: /** @class */ function Foo(...) {...} /** @function...