I like properly documented code and it is no-brainer for me to have properly documented public methods describing the contract and same applies for private or package internal methods to explain the code internals / implementation.
However I am not sure if I should in non-public and non-protected methods:
- adhere to all the formalities as are description of parameters, return value and exception
- if I should document self-explanatory private methods like
fireSomeEvent
where is obvious what it does at first sight as this only clutters the code
What is a standard approach to this?
javadoc
. – Resound