At 10/17/2005 01:10 PM, Palmer, Jean L. wrote:
>I would like to know how, in general, people document (in their code
>comments) the return value from a function, when that return value is
>actually based on something that happens in a different function.
>
>For instance, if I have a function named F1(), and its return value is the
>return value from function F2():
>
>bool F1()
>{
> // do some stuff
> return F2();
>}
Unless "do some stuff" is more than a screenful, I would not think
documentation is necessary.
Otherwise, say it returns F2().
Phil Daley < AutoDesk >
http://www.conknet.com/~p_daley
_______________________________________________
msvc mailing list
msvc@beginthread.com
See http://beginthread.com/mailman/listinfo/msvc_beginthread.com for
subscription changes, and list archive.
