Should I document my private methods?

documentation private-members
Jader Dias picture Jader Dias · Nov 16, 2009 · Viewed 11.1k times · Source

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

Answer

Reed Copsey picture Reed Copsey · Nov 16, 2009

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.

Related questions

Is there a way to create multiline comments in Python?

I have recently started studying Python, but I couldn't find how to implement multi-line comments. Most languages have block comment symbols like /* */ I tried this in Python, but it throws an error, so this probably is not the correct way. …

Read More
What is the standard Python docstring format?

I have seen a few different styles of writing docstrings in Python, is there an official or "agreed-upon" style?

Read More
#pragma mark in Swift?

In Objective C, I can use #pragma mark to mark sections of my code in the symbol navigator. Since this is a C preprocessor command, it's not available in Swift. Is there a stand-in for this in Swift, or do …

Read More