[Tutor] importance of Docstring

spir denis.spir at free.fr
Fri Apr 17 11:54:18 CEST 2009


Le Thu, 16 Apr 2009 12:02:21 +0200,
"A.T.Hofkamp" <a.t.hofkamp at tue.nl> s'exprima ainsi:

> Now what does this function do?
> This is a 'what' question, namely, from a design point of view, if I call
> this function, what does it do, and what is its result-value?
> 

What I miss is a good place for "why?". Which, when needed, is different from "what?" and "how?". Why tells about the reason-to-be: why did I (need to) write the following piece of code? Not always needed (while what is nearly always needed), though, but really helpful in this case.

Denis
------
la vita e estrany


More information about the Tutor mailing list