Commenting code

[tition]

Hi all,

Since I am about to share my code soon with some colleagues (I am not a professional programmer, nor are they), I have recently became more comment-conscious:

template <class ElementOfCommutativeRingWithIdentity>
class Polynomial: public HashedListBasicObjects
<Monomial<ElementOfCommutativeRingWithIdentity>>
{
public:
//If your name is (**the author of the code**), 
//do not use if you don't remember what it does!
//Otherwise don't use at all!
bool IsGreaterThanZeroLexicographicOrder();
};

[firedraco]

Fun...search google code for stuff like "I don't know how this works" for stuff like that

[helios]

It would have probably taken less time to actually describe what it does than to type all that.

[tition]

hehe you were supposed to ask:

And what does it do?

And I to answer:

I don't remember!

In fact it does something completely retarded (not what you would expect based on its name!), because I was too lazy to write it in a good fashion, hence the comment :)