Search code examples
documentationprivate-members

Should I document my private methods?


Private methods documentation can only be seen by who has access to the source code. Is it worth the effort spent on it?


Solution

  • Personally, I feel that it is. Documentation is often the most useful to future developers maintaining your software - especially member documentation.

    Even public API documentation is only of limited use to any audience other than a developer. Document for those following - they will thank you.