esdoc-plugins
esdoc-plugins copied to clipboard
How does Typescript ESDoc measure comment coverage?
I am writing in Angular4 and Typescript with the esdoc-coverage-plugin and esdoc-typescript-plugin.
In my codebase, every method, class, and member have a comment block in this form:
/** @method methodName
* @desc method description
* @param {type} paramName - description of paramName
* @returns {type}
*/
methodName(param: type) {
/** the if statement does this */
if(something) { doSomething(); } else { doSomethingElse(); } }
Some files reach 100% with this format, other files are stuck at 40%. Even after putting in placeholder comments above each line of code, even documenting each if-else branch in detail, I cannot raise the coverage. What am I missing?
I cannot provide a physical snippet of the code, but I can try and answer any follow up questions you have if you need more information to give me an answer, thank you.