in reply to Documenting non-public OO components
I don't think private methods should be documented in POD at all, otherwise they're not really private. Inline comments for people actually working on the code should be sufficient.
I tend to group 'protected' methods in a POD heading called 'SUBCLASSING' or something similar -- basically, "Here's what you can use and what you need to know to write a subclass", which is what protected methods are really for.
Chris
M-x auto-bs-mode
|
---|
Replies are listed 'Best First'. | |
---|---|
Re^2: Documenting non-public OO components
by creamygoodness (Curate) on Sep 06, 2005 at 17:24 UTC | |
by Ven'Tatsu (Deacon) on Sep 06, 2005 at 18:39 UTC | |
by creamygoodness (Curate) on Sep 06, 2005 at 19:08 UTC | |
by lachoy (Parson) on Sep 06, 2005 at 19:43 UTC | |
by revdiablo (Prior) on Sep 07, 2005 at 15:49 UTC | |
by creamygoodness (Curate) on Sep 08, 2005 at 00:17 UTC |
In Section
Meditations