I am not clear about "@since" and "@throws" tag .
First "@since" tag:
Below is a sample doc comment for a class.
/**
* Description of class
*
* @author xyz
* @version 1.0
* @since 1.0
*/
Is this(above) right doc comment(only concerned tags are given) for "@since" tag ?
If this class is modified, and as a result version becomes "1.2", then doc
comment modifies to --
/**
* Description of class
*
* @author xyz
* @version 1.2
* @since 1.0
*/
Am i right ( "version" changed to "1.2" and "since" is as it is "1.0")?
Suppose a new class is addedd in version 1.3 -- Is it ok to write doc comment for
this class like this(written below):
/**
* Description of class
*
* @author xyz
* @version 1.3
* @since 1.3
*/
For "@throws" tag:
Sun Java doc guidelines : "Multiple @throws tags (also known as @exception) should be listed alphabetically by the exception names."
Does this apply in method declaration also, to be specific
which is more appropriate from POV order of exception :
methodA() throws IOException, RemoteException; // Exceptions ordered alphabetically
or
methodA() throws RemoteException,IOExption ; // Exceptions are not ordered alphabetically .
Or it does not matter here at all.
Regards,
Akash
First "@since" tag:
Below is a sample doc comment for a class.
/**
* Description of class
*
* @author xyz
* @version 1.0
* @since 1.0
*/
Is this(above) right doc comment(only concerned tags are given) for "@since" tag ?
If this class is modified, and as a result version becomes "1.2", then doc
comment modifies to --
/**
* Description of class
*
* @author xyz
* @version 1.2
* @since 1.0
*/
Am i right ( "version" changed to "1.2" and "since" is as it is "1.0")?
Suppose a new class is addedd in version 1.3 -- Is it ok to write doc comment for
this class like this(written below):
/**
* Description of class
*
* @author xyz
* @version 1.3
* @since 1.3
*/
For "@throws" tag:
Sun Java doc guidelines : "Multiple @throws tags (also known as @exception) should be listed alphabetically by the exception names."
Does this apply in method declaration also, to be specific
which is more appropriate from POV order of exception :
methodA() throws IOException, RemoteException; // Exceptions ordered alphabetically
or
methodA() throws RemoteException,IOExption ; // Exceptions are not ordered alphabetically .
Or it does not matter here at all.
Regards,
Akash