Commenting for Clarity

Discussion: Commenting for Clarity

As you have learned in the text, the process of compiling code changes it into a machine-readable (rather than user-readable) language your computer can then execute. The compiling process ignores any comments entered by the user, as they have no effect on the operation of the program. However, comments within code are valuable to you and any users who will read your code, arguably as important as the code itself.

Always comment your source code fully. You may be tempted to skip this step in the midst of coding because the program and all of its component classes, methods, and objects are fresh in your mind. When you move on to other projects, or return to a half-finished program later, those comments will be invaluable guides. Comments help you avoid much time and anguish trying to understand the code. The importance of commenting is even further underscored when you work with other programmers or when that code will eventually be maintained by someone else. Without thorough commenting, you have already made the job harder for future administrators of the program—before they have laid eyes on the code or even inspected a single method. Clients that cannot make sense of the code they paid for will be far less likely to seek you out for future programming jobs.

Review the sections of the text that refer to comments, including the three different methods you can use to code comments in Java. Next, 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: JavaWorld (https://www.javaworld.com/blog/open-source-java-projects/), and Java-Source (Open Source Software in Java).

 

Open Source Software in Java

You will notice that the quality of the programs and the quality of the programming varies greatly. Try to remember that these open source projects are posted by programmers of all different levels of experience, and the projects are in various stages of development. As such, they do not always embody sound programming practices.

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.

By Day 3

Post a response that summarizes your findings. The post should:

  • 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.
  • Identify the methods within the example program you believe are not sufficiently documented.
  • Examine the control flow statements to determine what they do and if their purpose is clearly documented.
  • Explain why you feel the current commenting within the project needs improvement.

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.

Get 20% Discount on This Paper
Pages (550 words)
Approximate price: -

Try it now!

Get 20% Discount on This Paper

We'll send you the first draft for approval by at
Total price:
$0.00

How it works?

Follow these simple steps to get your paper done

Place your order

Fill in the order form and provide all details of your assignment.

Proceed with the payment

Choose the payment system that suits you most.

Receive the final file

Once your paper is ready, we will email it to you.

Our Services

Ace Writing Center has stood as the world’s leading custom essay writing services providers. Once you enter all the details in the order form under the place order button, the rest is up to us.

Essays

Essay Writing Services

At Ace Writing Center, Nowadays, students normally have extremely busy schedules. You will note that some of them have to take on some evening or weekend jobs in order to get some income that can help them to sustain in college or in the university. This can deny them a chance to write all the essays given. Others usually get bombarded with a lot of work by their lecturers. This can still delay such students from working on all their essays. However, some of them usually try to work on all these essays but end up delivering their work late. This can prevent them from graduating since most lecturers are strict on deadlines. If you want to write a business essay, the wise way is to hire an outstanding essay writing service like us, so that you can get the best results. If you are keen, you will note that many companies usually overcharge their customers. Some of them are there only to make money. And in reality, they really don’t care to build a long term commitment with students. You should not choose such companies. You should take your time and choose a reliable company to work with. Ace Writing Center is the ultimate solution for you. We have been offering our writing service for more than 7 years. This is a clear indication that you will get quality essay writing service. We have a wide range of writers who can work on any business essay that you might have. We believe in doing extensive research so that we can provide quality work to all our clients. .

Admissions

Admission and Business Papers

Have you ever had to write an admission essay for college? The majority of students face the same issues when applying to a university or college and many in such situations decide they need professional help to cope with this matter. They get in a situation when the deadline keeps coming closer but lack motivation to start because they are just not sure if their writing skills are strong enough. We have a solution for you! Ace Writing Center is the best admission essay writing service with a large professional team and years of experience in providing high-quality papers to students of all levels and faculties. The mission of our team is to help students make their dreams of entering a good college come true and that’s what we offer!.

Editing

Editing and Proofreading

Sometimes all the words for your paper just flow out of your mind and into your fingers. You type quickly at your keyboard and there they are, your beautiful words right there on the screen. But you have no idea how to polish it up. You may be wishing there was a paper writing service that offered this type of writing service. Look no more! Here at Ace Writing Center, we offer you an editing and proofreading option that you can't find anywhere else..

Coursework

College Essay Writing

In case you are familiar Ace Writing Center, you know the way to distinguish a better company from a cheap one exactly. First of all, poor service website does not have a sufficient support. We think support team is an essential part of success; it has to answer all clients’ questions and be a connecting link between clients and their writers. On our web-service you will get answers about anything you need and your writer will receive all your instructions, assignments and requirements exactly and swiftly. A writing service that we run has got a flexible pricing system that will save you from senseless wastes and many bonus systems that let you sparing money for something important for you.

See all services