
31 Oct
2010
31 Oct
'10
10:25 p.m.
Talking about documentation in the 3rd year software engineering paper I teach, I give JavaDoc as an example of what not to do. I give R as an example of something that works quite well. It's *examples* that make the difference.
One thing I will say for the JavaMail specification is that it has some useful examples.
+1 to documentation with some samples. Back in my PHP days, I used to love the fact that the PHP docs had not only examples by the developer, but also comments with examples from the community. Daniel