[arc-discuss] When should interfaces be private?

David Edmondson dme at sun.com
Fri May 2 09:42:05 PDT 2008


On 2 May 2008, at 5:31pm, Philip Brown wrote:
> Having the original engineer spend 5 minutes on documentation, can  
> save some
> later person looking at the code, 5 *days*.

For a piece of code that will take me 5 days to understand I can't  
write useful documentation in 5 minutes.

I'm not sure how much useful documentation I can write about anything  
in 5 minutes. Perhaps I'm alone in that, but I doubt it.

In any case, I'm sure that everyone will agree that our code should be  
better documented. That's somewhat tangential to the 'private  
interfaces' debate.



More information about the arc-discuss mailing list