Death by a Thousand Cuts: Poor, Incomplete Documentation [COLUG]

[Jim]

Duane wrote:

> Jim wrote: 

> > Also document what's obvious to you, 
> > like what language you're writing in. 
> 
> I thought the page title would have been a clue :)

Yes, the page title is a clue, 
but clues and smiley faces are poor documentation. 
Poor, incomplete documentation is death by a thousand cuts. 
Make OSS better than proprietary software. 

It's better to state explicitly what's obvious to you. 
All the more so when you mention "java midlets" shortly before the code. 

Remember to document the many other things that are obvious to you, 
like what the input to and output from functions are.