SV: Regarding coding style
K Viltersten
tmp1 at viltersten.com
Sat Mar 8 22:06:36 EST 2008
>> /** Projects an object from 3D to 2D using
>> the method of Alexander The Great.
>> \param 3D structure to be projected
>> \returns 2D projection
>> */
>> public Proj2D get2Dfrom3D(Proj3D param);
>>
>> The above is, to me, very clear and
>> consistent. Not to mention, easily
>> handled with e.g. Doxygen to create a
>> readable documentation.
>>
>> I don't see how this is dislikeable. Please
>> explain.
>
> When get2Dfrom3D changes its signature but
> the comment is not changed. That's where I
> have a problem, and it's only a matter of
> time before it happens.
I think we've arrived at the spot where i'll
claim that a _always_ update my comments,
and you'll question that i can (in the long
run). Let's agree on that! :)
--
Regards
Konrad Viltersten
--------------------------------
sleep - a substitute for coffee for the poor
ambition - lack of sense to be lazy
More information about the Python-list
mailing list