Skip to main content
Software Engineering

Return to Answer

added 222 characters in body
Source Link
Bob Santos
Bob Santos
  • 1
  • 2

Knowing that those methods are common and most of the developers will know what they are for then, IMO, you won't need to put any comments there. The better approachComments are not that reliable in the long run as there are chances that these may not get updated when the implementation is updated and might cause confusion. So it is always better to make your code readable as this is what you can mostly trust.

Furthermore, I would say that if the code you are creating/editing is not for a public API then just leave out the javadocs for common methods as these will just add clutter and noise.

Knowing that those methods are common and most of the developers will know what they are for then, IMO, you won't need to put any comments there. The better approach is to make your code readable.

Furthermore, I would say that if the code you are creating/editing is not for a public API then just leave out the javadocs for common methods as these will just add clutter and noise.

Knowing that those methods are common and most of the developers will know what they are for then, IMO, you won't need to put any comments there. Comments are not that reliable in the long run as there are chances that these may not get updated when the implementation is updated and might cause confusion. So it is always better to make your code readable as this is what you can mostly trust.

Furthermore, I would say that if the code you are creating/editing is not for a public API then just leave out the javadocs for common methods as these will just add clutter and noise.

Source Link
Bob Santos
Bob Santos
  • 1
  • 2

Knowing that those methods are common and most of the developers will know what they are for then, IMO, you won't need to put any comments there. The better approach is to make your code readable.

Furthermore, I would say that if the code you are creating/editing is not for a public API then just leave out the javadocs for common methods as these will just add clutter and noise.