File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
http://aspose.com/file-tools
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Commenting code

 
Wade Broke
Greenhorn
Posts: 1
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 10971
11
Android Eclipse IDE Google Web Toolkit Java Mac Ubuntu
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Welcome to the Ranch.
You might find this useful http://java.sun.com/docs/codeconv/
 
Rob Spoor
Sheriff
Pie
Posts: 20372
44
Chrome Eclipse IDE Java Windows
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
how to write affective comments in java class file?
 
Campbell Ritchie
Sheriff
Pie
Posts: 47229
52
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Welcome to the Ranch

You will find your code easier to read if you use the "Code" button.
 
Don't get me started about those stupid light bulbs.
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic