jsdoc-vuejs not compatible with JavaScript modules?
See original GitHub issueJSDoc-vuejs is great. But when I use it, the comments for function in a module will disappear.
For example, I create a vue project:
vue init jsdoc-test
cd jsdoc-test
npm install -S jsdoc jsdoc-vuejs
And then I create the configuration file jsdoc.config.json
:
{
"plugins": [
"node_modules/jsdoc-vuejs"
],
"source": {
"includePattern": "\\.(vue|js)$"
}
}
There are two modules: test-es.js
and test-common.js
:
/**
* @module /test-es
*/
/**
* print hello
*/
function hello () {
console.log('hello');
}
export default {
hello
};
/**
* @module /test-common
*/
module.exports = {
/**
* @param {string} i - parameter to be printed
*/
test: function(i) {
console.log(i);
}
};
Then I test them with and without jsdoc.config.json
:
jsdoc -c jsdoc.config.json test-es.js test-common.js
jsdoc test-es.js test-common.js
The results are different: comments for the methods disappear if I use jsdoc.config.json
.
Do I miss something or is there a real issue?
Issue Analytics
- State:
- Created 5 years ago
- Comments:8 (5 by maintainers)
Top Results From Across the Web
jsdoc-vuejs - npm
A JSDoc plugin for documenting vue 3 files.. Latest version: 4.0.0, last published: a year ago. Start using jsdoc-vuejs in your project by ......
Read more >JavaScript modules via script tag | Can I use... Support tables ...
Loading JavaScript module scripts (aka ES6 modules) using <script type="module"> Includes support for the nomodule attribute. Usage % of.
Read more >JavaScript modules - MDN Web Docs
This guide gives you all you need to get started with JavaScript module syntax. ... Report problems with this compatibility data on GitHub ......
Read more >Javascript module not working in browser? - Stack Overflow
0. The short answer. You need to install and run a local web server. - For a suggestion on how, read on. 1....
Read more >Modules in JavaScript – CommonJS and ESmodules Explained
ESmodules is a more modern approach that is currently supported by browser and server-side apps with Node. Let's see this in code. Once...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
It works!. Thanks.
Released in v2.3.1