Menu

#32 Tool for technical documentation by adding path parameter

open
nobody
5
2010-04-07
2010-04-07
alex
No

Just got into this project coming from wikipedia (Software_documentation) because it looks an excellent and unique solution for solving the problem of efficient code documentation among developers. It just misses some features.
Here is the need first:
- PHP is a scripting language and has the same drawback as any other scripting languages: the more comments one should put into it the slower the file will be parsed so seems natural to put there some short "links" only toward documentation (here's kelp !)
- everyone seems to think as comments going from sourcecode to documentation but not back. But the documentation has different meanings: one is user manual, one is developer manual (or api reference) and another is the technical documentation (here's kelp !)

So, you though to this , it should be very useful but seems the project is suspended. If you think to make some additions to it then I can suggest a few:
- add path parameter to kelp executable. I can imagine a mirror directory structure of the current project which in PHP means lots of files and folders. The documentation for each can stay in its own mirror folder and kelp can access it by the name of the current file. That allows a smooth integration with IDEs like: click on a kelp tag in a sourcecode (enclosed in comments) and will open a popup with the output of kelp application about that tag in the mirror file. Same as with writing such tags: write the tag, click on it, add documentation into the popup, save and voila: excellent technical notices. That should have a great value (commercial too).

In the meantime I will keep monitoring this project for goodies. Good luck !

Discussion


Log in to post a comment.