Erick setup a repository with a script to setup JsDoc and other tools (js_tools.git).
After toying some more with small bits of JavaScript and JsDoc, I will have to agree with Marc and Bruno regarding the module prefixes. It seems that JsDoc doesn't document modules very well even when they are objects. We should possibly consider trying to improve the tool ourself. If we could have a per-file summary, it would already be better.
I have also discovered that there are problems due to the initialization order. Functions in all JavaScript files are globally defined before anything else, but only if they are defined using the function somename() syntax, not if we assign them to a variable. Hence, defining functions globally saves us the trouble of having to figure out in what order we have to define functions.
However, I would propose, as a compromise, that we still name the functions themselves using hungarian notation, eg:
mem_ptrSub ast_prettyPrint
As for class names, unless there are collisions, I suggest we name them with Hungarian notation, starting with a capital letter, eg:
BaseInstr Parser
Does this sound like a reasonable compromise?
- Maxime