Object Oriented Software Engineering   View all facts   Glossary   Help
subject > programming language construct > comment
Next programming language constructcondition    Upprogramming language construct    Previous programming language constructclass   

comment comparison table
Subject describe have example be about have purpose write at be is a subtopic of is a kind of write before have form write
Java commentthe purpose of the class, how it should be used, its authors and its history of modification
executeMeToo(); /* This is to be ignored
and this too */
obvious things since they add clutterto describe the purpose of each class, method and variable along with any difficult-to-understand statements inside methods, and to indicated any changes to the codethe top of each classbetween about 20% and 35% of the total length of the codeThe Basics of Javacommentwriting the code'/*' comment '*/' or two slashes '//' indicating that the rest of the line is to be considered a commentto describe loops and conditional statements inside complex algorithms

Next programming language constructcondition    Upprogramming language construct    Previous programming language constructclass