aspose file tools*
The moose likes Beginning Java and the fly likes Commenting code Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "Commenting code" Watch "Commenting code" New topic
Author

Commenting code

Wade Broke
Greenhorn

Joined: Jan 18, 2010
Posts: 1
Can someone tell me if there is a standard for commmenting code (to produce javadocs and in general)

Some examples would be good if there is a standard for this

or some commenting of this code would be helpful

/**
*
* @author Wade B
*
*/
public class roundRobinScheduler
{

/**
*
*
* @param args
*/
public static void main(String[] args)
{

process p1 = new process( "First Process", 10 );
process p2 = new process( "Second Process", 14);
process p3 = new process( "Third Process", 30);
process p4 = new process( "Fourth Process", 7 );

process[] allJobs = { p1, p2, p3, p4 };

boolean allProcessesComplete = false;



int currentJobIndex = 0;

while( !allProcessesComplete )
{
if( !allJobs[currentJobIndex].complete())
{
allJobs[currentJobIndex].processTimeslice(1);
try
{
java.lang.Thread.sleep(500);
}
catch( Exception e)
{

}
}


currentJobIndex++;


if( currentJobIndex >= allJobs.length)
{
currentJobIndex = 0;
}

if( p1.complete() && p2.complete() && p3.complete() && p4.complete())
{
allProcessesComplete = true;
}


}

}

}
Maneesh Godbole
Saloon Keeper

Joined: Jul 26, 2007
Posts: 10384
    
    8

Welcome to the Ranch.
You might find this useful http://java.sun.com/docs/codeconv/


[How to ask questions] [Donate a pint, save a life!] [Onff-turn it on!]
Rob Spoor
Sheriff

Joined: Oct 27, 2005
Posts: 19696
    
  20

how to write affective comments in java class file?


SCJP 1.4 - SCJP 6 - SCWCD 5 - OCEEJBD 6
How To Ask Questions How To Answer Questions
Campbell Ritchie
Sheriff

Joined: Oct 13, 2005
Posts: 38881
    
  23
Welcome to the Ranch

You will find your code easier to read if you use the "Code" button.
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: Commenting code