update: Ik zie dat de tags jsdoc en outliner nog niet bestaan op GoT, dus ik ben bang dat dit een tumbleweed-topic gaat worden.
Neem de volgende node.js code in Eclipse:
Ik heb nu module.exports.doGrapje allemaal in de outliner staan. Maar nu wil ik mijnGrapje.on('grapje') ook onder doGrapje hebben.
Ik weet dat officiëel geen functie is, maar daar is JSDoc toch o.a. voor? Om het te casten? Want dergelijke constructies gebruik je meer en meer, en er kan een compleet stuk code in zo'n on('', {}) staan, waardoor je graag een outliner-overzicht hebt. Maar alle JSDoc lijkt te worden genegeerd, behalve @memberOf (en de standaard param/return blahblah).
Met @memberOf kan je elke variabele in een bestaande of fictieve parent stoppen. Gek genoeg krijg ik met @member dan weer geen resultaat, waarmee je een variabele zelf als fictieve naam in de outliner zou moeten kunnen zetten.
Ik heb nog wat meer tags geprobeerd op verschillende plaatsen, en ik weet niet precies wat meer omdat ik er vanuit ging dat ik er wel achter kwam zonder naar GoT te stappen.
Maar als iemand gewoon weet hoe het wel kan, is het verder ook niet zo relevant als ik een gedetailleerd overzicht geeft van wat allemaal niet werkt.
Iemand die hier ook mee werkt en de correcte methode weet?
Neem de volgende node.js code in Eclipse:
code:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
| module.exports = { /** * memberOf is nodig omdat JSDoc een zonder het te weten reeds bestaand object (module) niet gaat outlinen: * @memberOf module.exports */ doGrapje : function(response) { var mijnGrapje = new EventEmitter(); // Some code mijnGrapje.on('grapje', function(grapje) { //FIXME: Dat kan slechter if (grapje.slecht.hoeveel <= 0) { // irrelevante functie } }); } }; |
Ik heb nu module.exports.doGrapje allemaal in de outliner staan. Maar nu wil ik mijnGrapje.on('grapje') ook onder doGrapje hebben.
Ik weet dat officiëel geen functie is, maar daar is JSDoc toch o.a. voor? Om het te casten? Want dergelijke constructies gebruik je meer en meer, en er kan een compleet stuk code in zo'n on('', {}) staan, waardoor je graag een outliner-overzicht hebt. Maar alle JSDoc lijkt te worden genegeerd, behalve @memberOf (en de standaard param/return blahblah).
Met @memberOf kan je elke variabele in een bestaande of fictieve parent stoppen. Gek genoeg krijg ik met @member dan weer geen resultaat, waarmee je een variabele zelf als fictieve naam in de outliner zou moeten kunnen zetten.
code:
1
2
3
4
5
6
7
8
9
10
11
| /** * Some code * @namespace module.exports.doGrapje // werkt niet * @module module/exports/doGrapje // werkt niet * @exports module/exports/doGrapje // werkt niet * @member nepNaamVoorOutliner // werkt niet * @memberOf // zet alleen de fictieve parent in de outliner */ mijnGrapje.on('grapje', function(grapje) { //FIXME: Dat kan slechter |
Ik heb nog wat meer tags geprobeerd op verschillende plaatsen, en ik weet niet precies wat meer omdat ik er vanuit ging dat ik er wel achter kwam zonder naar GoT te stappen.
Maar als iemand gewoon weet hoe het wel kan, is het verder ook niet zo relevant als ik een gedetailleerd overzicht geeft van wat allemaal niet werkt.
Iemand die hier ook mee werkt en de correcte methode weet?
🇪🇺 Buy from EU (GoT)