Examine the source code for one or more open source projects

Assignment Help Software Engineering

Reference no: EM131200388

Discussion Post-Commenting for Clarity

Go to any open source repository, where software developers collaborate on the development of open source software, and download the code from one or more open source projects. Some potential repositories to explore are: SourceForge (sourceforge.net), JavaForge (javaforge.com), and Google Code (code.google.com)

Examine the source code for one or more open source projects and locate an example in which: (1) the documentation and commenting within the program leaves something to be desired and (2) more than one control flow statement is used. Inspect the code for the individual source files. If you are able to build the project, run the program a few times so you understand what the author of the program was trying to achieve and how the lines of code in the project work. Think about how the commenting could be improved.

Post a response that summarizes your findings. The post should

1. Include a link to the open source project you chose as an example of poor commenting, or attach an example source file to your posting.

2. Identify the methods within the example program you believe are not sufficiently documented.

3. Examine the control flow statements to determine what they do and if their purpose is clearly documented.

4. Explain why you feel the current commenting within the project needs improvement.

5. Copy the example code into your post, replacing or adding detail to the current comments in order to make the program easier for a user to understand.

Reference no: EM131200388

Questions Cloud

What is a cross join and give an example of its syntax : What is a CROSS JOIN? Give an example of its syntax. What three join types are included in the OUTER JOIN classification? What is a correlated subquery? Give an example. What is a subquery, and what are its basic characteristics?

Describe the cultural and social factors : 1. List and describe the cultural and social factors that influence consumer buying behavior, giving examples of each. 2. There are two popular theories of motivation as our insight into why people would buy what they do. Describe each of these two..

Ethical requirements on small businesses : Should the law impose ethical requirements on small businesses or privately held companies or can the marketplace police unethical business behavior? Provide support to justify your position.

Determine the time when they come side by side : Car B has a speed of 120 ft> s and is decreasing its speed at 15 ft> s2 until it travels a distance of 65p ft, after which it maintains a constant speed. Determine the time when they come side by side.

Examine the source code for one or more open source projects : Examine the source code for one or more open source projects and locate an example in which: the documentation and commenting within the program leaves something to be desired.

How would you handle their repatriation : What kind of training would you give them prior to their departure for their new assignment? ( include cross culture training) How would you handle their repatriation? How will you compensate them?

Collate your findings in the form of an executive summary : Review the 2010 case study. Establish a cause-effect analysis on why financial information is so popular with organized criminals. Collate your findings in the form of an executive summary.

How fast did mr. h walk during the first 5.0 seconds : The position-time graph below represents his motion. Use the graph to answer the next several questions.

Calculate total investment for this nation for the year : Calculate total investment for this nation for the year. Calculate GDP for this nation for the year.

User Account

All Pages