Closed zmalkmus closed 11 months ago
jinningwang
commented
11 months ago Zack, well done! I believe this can greatly improve the maintainability of AGVis.
The blog link you insert seems to be invalid. Is there any automated tool can do this for your future development? If so, you can save manual efforts in the future.
zmalkmus
commented
11 months ago Zack, well done! I believe this can greatly improve the maintainability of AGVis.
The blog link you insert seems to be invalid. Is there any automated tool can do this for your future development? If so, you can save manual efforts in the future.
Sorry about that, I messed up the link placement. Its fixed now.
I'm not sure if there are tools for auto commenting in this particular style, but it will be trivial to maintain this commenting style with future development anyways.
jinningwang
commented
11 months ago Zack, well done! I believe this can greatly improve the maintainability of AGVis. The blog link you insert seems to be invalid. Is there any automated tool can do this for your future development? If so, you can save manual efforts in the future.
Sorry about that, I messed up the link placement. Its fixed now.
I'm not sure if there are tools for auto commenting in this particular style, but it will be trivial to maintain this commenting style with future development anyways.
No need to do this for all files in the future, just mark the most important files to your perspective.
I have added developer comments for each AGVis js file. Each one includes a header that describes the author, date modified, description of the file, and a link to the API documentation. I mostly created header comments for each function per the following standard [ link ]. I also created breaks in logical code sections for readability. Finally, I reformatted the code styling (indentations mostly) to be consistent across all js files.