When should we write javadoc?

[WeiJie96]

Should we write javadoc for obvious methods? E.g. getters/setters, one/two-liners that just prints out a string
Should we write javadoc for all non-private (includes package, protected, public) methods and classes, or just the public ones?

[damithc]

General rule:

• If specified in the coding standard, follow it strictly. No deviations.
• If not specified in the coding standard, you can make your own decision but it should be applied consistently i.e., the whole team needs to agree and follow. Some options you can use here:
  • Follow what the current code seems to be following implicitly
  • Follow what's specified by one of the more detailed coding standards cited by our own coding standard (see the references section)

[WeiJie96]

Thank you for the detailed explanation, Prof Damith!