Search code examples
javaeclipsecommentsenterprise

The best way to comment code in Java


What's the best way to comment code in Java, is there a way to generate the function name and the parameters automatically in Eclipse ?

For example I'm writting those comments manually :

// <summary>
// Some comments about the function
// </summary>
// <param name="id">the user ID</param>
// <param name="username">The user password</param>
// <returns></returns>
public Connect(int id, String password)
{

}

Thanks already.


Solution

  • I personally prefer to use JAutodoc plugin for commenting. Take a look at it. Its good.