Examine the source code for one or more open source projects
Dialogue Put up-Commenting for Readability
Go to any open source repository, the place software program builders collaborate on the growth of open source software program, and obtain the code from one or more open source projects. Some potential repositories to discover are: SourceForge (sourceforge.web), JavaForge (javaforge.com), and Google Code (code.google.com)
Examine the source code for one or more open source projects and find an instance wherein: (1) the documentation and commenting inside the program leaves one thing to be desired and (2) more than one management stream assertion is used. Examine the code for the particular person source recordsdata. If you’ll be able to construct the venture, run the program a couple of instances so that you perceive what the writer of the program was making an attempt to attain and the way the traces of code in the venture work. Take into consideration how the commenting could possibly be improved.
Put up a response that summarizes your findings. The put up ought to
1. Embody a hyperlink to the open source venture you selected for instance of poor commenting, or connect an instance source file to your posting.
2. Determine the strategies inside the instance program you consider will not be sufficiently documented.
three. Examine the management stream statements to find out what they do and if their objective is clearly documented.
four. Clarify why you are feeling the present commenting inside the venture wants enchancment.
5. Copy the instance code into your put up, changing or including element to the present feedback with a purpose to make the program simpler for a person to know.
