Do I need to javadoc every single method or just the 'main' method in java?

Posted by Chris on Stack Overflow See other posts from Stack Overflow or by Chris
Published on 2009-12-02T18:23:01Z Indexed on 2010/04/09 12:13 UTC
Read the original article Hit count: 344

Filed under:

java

|

javadoc

|

best-practices

Java example method:

//Stores the user input into an integer variable called 'choice'
int choice = keyboard.nextInt();

Do I need to write javadoc for a simple method like this or should I only document the main method of any program, if so then what sort of things should I write for the main method?

Thanks,

Chris.

© Stack Overflow or respective owner

Related posts about java

Tomcat 6: Access Control Exception?

as seen on Server Fault - Search for 'Server Fault'
I'm trying to setup a tomcat6 server, and I'm trying to match another setup someone else established. However, my deployment (default Ubuntu install) uses a policy.d/ directory structure, and the established server just uses a catalina.policy file. I've tried setting every entry in policy.d to match… >>> More
Problem in creation MDB Queue connection at Jboss StartUp

as seen on Stack Overflow - Search for 'Stack Overflow'
I am not able to create a Queue connection in JBOSS4.2.3GA Version & Java1.5, as I am using MDB as per the below details. I am putting this MDB in a jar file(named utsJar.jar) and copied it in deploy folder of JBOSS, In the test env. this MDB works well but in another env. [ env settings and… >>> More
failing to establish connection between Postgres db and gwt

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, I am using Postgres and gwt 2.0 for one of my applications. I am facing problem connecting to the database. When I try to connect it gives "ClassNotFoundException". Here is what I get when I try to connect to database: java.lang.ClassNotFoundException: org.postgresql.Driver at java.net… >>> More
failing to establish connection between postgre db and gwt

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, For i am using postgre and gwt 2.0 for one of my applications. I am facing problem connecting to the database. When i try to connect it gives "ClassNotFoundException". Here is what i get when i try to connect to database: java.lang.ClassNotFoundException: org.postgresql.Driver at java.net… >>> More
Migration and deployement problems JBoss 4.2.2.GA to JBoss 6.0.0.M2

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, I'm trying to migrate an application running on JBoss 4.2.2.GA to JBoss 6.0.0.M2 I give you some log to explain my problem : boot.log : 2010-03-16 09:59:29,406 ERROR [org.jboss.system.server.profileservice.ProfileServiceBootstrap] (Thread-2) Failed to load profile: Summary of incomplete deployments… >>> More

Related posts about javadoc

Create javadoc with multiple src dirs

as seen on Stack Overflow - Search for 'Stack Overflow'
I have a Util package with source files in three seperate directories, defined like so: src/com/domain/util src/Standard/com/domain/util src/Extended/com/domain/util The package is built with the first set of files and either one of the second or third set, to create a total of two different implementations… >>> More
javadoc and overloaded methods

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi all, I'm developing an API with many identically named methods that just differ by signature, which I guess is fairly common. They all do the same thing, except that they initialize various values by defaults if the user does not want to specify. As a digestible example, consider public interface… >>> More
Javadoc through Ant task with {@inheritDoc} from J2SE classes

as seen on Stack Overflow - Search for 'Stack Overflow'
I generate documentation for a project using an Ant task. In several places, I wanted to inherit documentation from the standard classes, so I used {@inheritDoc} which allowed me to see the Javadoc in Eclipse, but it wouldn't show up in the HTML files. The problem was that I hadn't included the unzipped… >>> More
how generate javaDoc from a jaxb file

as seen on Stack Overflow - Search for 'Stack Overflow'
hi, i am working with Jaxb. and i would like to generate javaDoc files from these classes, is it the same way as i would do it to a regular java files? >>> More
Getting javadoc for Google Wave robot programming in Eclipse

as seen on Stack Overflow - Search for 'Stack Overflow'
Hey, Does anyone know how I can get the helpful Eclipse popups with javadoc when programming for the Google Wave Robots API? I have access to the JAR-file, the HTML Javadoc, as well as the source files from here How do I set up eclipse so I get javadoc integrated? I have tried adding the source… >>> More