Sample Report

Why use comments to build JCreator

David Sher

Comments are an important tool for programming. They are especially important when constructing large projects. Below we discuss why comments are particularly useful for building a program like JCreator

· JCreator is a valuable program. Comments allow you to copyright the source code of this program and thus prevent others from using your work to make money from JCreator.

· Many revisions of JCreator have come out. Each time it is revised, code that may have been written years ago needs to be changed. Comments help programmers understand old code and speed changing it.

· Comments can notify programmers that two pieces of code depend on each other and when one is changed, the other must be too. Such comments avoid inconsistencies and bugs in revisions. Since JCreator is frequently revised this is an important use for comments when building JCreator.

· JCreator is a large programming project. Many programmers work together to build it. Comments help each programmer understand what the other programmers are doing.

· JCreator contains many function calls in its code to perform the many operations you can get at through the menus. Comments can clarify what each function actually does and what their parameters are for.

· Because JCreator was built by multiple programmers, you may not know which programmer to ask about a feature or bug in the program. Comments can indicate which programmer built or revised which part of the program and then you know whom to look up.