Описание тега esdoc
Use esdoc for questions related to the ESDoc library, which is used to generate documentation from annotations and comments in ECMAScript
0
ответов
Создавайте связи между функциями / классами ESDoc и страницами справочника и наоборот.
Я новичок в ESDoc, но у меня есть многолетний опыт работы с JSDoc. Ближайшим эквивалентом функций учебников JSDoc является функция справочника ESDoc. Это позволяет вам написать отдельную документацию по уценке, которая будет включена в окончательную…
04 июл '18 в 16:31
0
ответов
EsDoc не любит документировать простые объекты на уровне членов - обходной путь?
Учитывая следующую конструкцию: BigBoss.specify({ /** * EsDoc, will not show me */ val:'val', /** * EsDoc, will not show me */ fn:function(){ return 'fn'; } // lots more members I want to documenent in EsDoc }); И это также не удается: const bigspec…
19 фев '17 в 00:24
1
ответ
ESDoc: игнорирование определенного файла
При попытке документировать файл JavaScript произошла ошибка. Чтобы решить эту проблему, стратегия будет следовать в другом направлении. Мы стремимся игнорировать причину проблемы, поскольку код делает то, что мы хотим. Для этого проекта мы использу…
18 июн '18 в 13:54
2
ответа
Работает esdoc есть ошибка
Чтобы сгенерировать документ, я хочу использовать esdoc esdoc -c esdoc.json esdoc.json { "source": "./src/", "destination": "./doc" } ./src/index.js /** * @type {Object} * @property {boolean} Foo.info */ var Foo = { info: true }; export default Foo;…
25 янв '17 в 21:49
0
ответов
Как документировать литералы объектов в ESDOC
Документация не упоминает об этом. https://esdoc.org/manual/usage/tags.html Любой знает, как документировать литералы объектов в ESDoc и создавать отчет, который описывает объект со всеми методами и значениями. Хотелось бы узнать, как документироват…
24 янв '17 в 11:22
2
ответа
Можно ли документировать простой объект JavaScript с помощью ESDOC?
Кажется, что ESDOC нацелен только на стиль класса ES6. Есть ли способ документировать простой объект, такой как: /** * ??? */ var Foo = { /** * ??? */ info: true }; export default Foo; И даже при использовании стиля класса ES6, как задокументировать…
29 дек '16 в 23:35
1
ответ
Как Typescript ESDoc измеряет покрытие комментариев?
Я пишу на Angular4 и Typescript с помощью подключаемого модуля esdoc-cover-plugin и https://www.npmjs.com/package/esdoc-typescript-plugin. В моей кодовой базе каждый метод, класс и член имеют блок комментариев в этой форме: /** @method methodName * …
28 авг '17 в 19:30
0
ответов
Соберите все `@todo`s 'в один файл с помощью`esdoc`
Я сейчас пользуюсь esdoc документировать мой проект узла. По всему моему проекту разбросано много @todo теги. Я хотел бы собрать все эти теги в одном документе, который затем будет включен в набор создаваемых документов. Предпочтительно, это будет т…
29 авг '18 в 13:07
1
ответ
Использование esdoc для файлов jsx
Я хочу создать документ для .jsx файлы .esdoc.json: { "source": "./src/", "destination": "./doc" } Но esdoc просто используйте .js файлы в ./src создать документ. Итак, как мне настроить esdoc для создания документа для файлов.jsx?
27 янв '17 в 15:48
0
ответов
Автоматическая генерация покрытия документа приложения AngularJS
Я использовал теги "ngdoc" для автоматического создания документа приложения AngularJS ( https://www.npmjs.com/package/gulp-ngdocs). Теперь мне нужно понять, возможно ли также получить процент охвата этой документацией. Не имеет значения, нужны ли м…
15 мар '19 в 09:17
0
ответов
Разобрать javascript в теге <script> в.html файле с документацией
У меня может быть особенно уникальный случай использования, но я заинтересован. Мне нужно только документировать javascript в <script> тег .html файл. Файлы не могут быть разделены из-за требований поставщика. Как это можно сделать для кода ни…
20 июн '19 в 08:17
1
ответ
Как документировать объект, содержащий объекты, с помощью ESDoc
Я пытаюсь задокументировать объект, содержащий другие объекты в конструкторе класса, используя ESDoc (синтаксис, аналогичный JSDoc). /** * A description. * @type {object} */ this.materialProperties = { paper: { roughness: 0.5, metalness: 0.0, reflec…
28 июл '19 в 19:15
0
ответов
ESDoc с TypeScript: как использовать блоки комментариев?
Я использую ESDoc для создания документации для проекта JS. Это работает хорошо! Теперь я хочу перенести этот JS-проект в TS-проект. Что касается документации, я видел этот плагин, который помогает ESDoc обрабатывать TypeScript. Это виды работы. Про…
12 дек '19 в 00:13
0
ответов
Как использовать ESDoc с ECMAScript 2018 (ES9)?
ESDoc не может проанализировать эту строку: const a = {...obj} Сообщение об ошибке: warning: could not parse the following code. if you want to use ECMAScript proposals, see https://esdoc.org/manual/feature.html#ecmascript-proposal Конфигурация ESDo…
23 апр '20 в 14:04
1
ответ
ESDoc: как исключить каталог
У меня есть 2 каталога, один для создания документации, а другой нет. Они: клиент-разработчик клиент Справочник должен быть включен в генерирующую документацию. Другой не должен быть включен. Мой файл .esdoc.json: { ... "excludes": ["(node_modules|c…
20 май '21 в 17:14
0
ответов
Как документировать события с помощью ESdoc?
Используя ESDoc, есть ли способ документировать события, используемые в коде, таком как: class Example extends EventEmitter { doSomethingAsynchronously () { ....then( () => this.emit('anevent', params) ).... } // and many other methods that can a…
19 дек '22 в 20:11