Felipe Monteiro de Carvalho schrieb:
On Wed, Nov 16, 2011 at 4:01 PM, Felipe Monteiro de Carvalho
<[email protected]> wrote:
Please never document something as "[?] Does nothing."

Just to add on that, I think it would read much better like this:

This method is provided for descendent classes so that they may
override it and do something when the active state of the form
changes. In TCustomForm it does not do anything by design.

I'd prefer:

This method is called [when?]
It can be overridden [to do what?]

With the placeholders filled in with *reliable* and *useful* information. It should be obvious that virtual methods are designed for being overridden in derived classes. But he who overrides such a method *must* know about the purpose of the method, else nobody can ever override it in a meaningful way.

DoDi


--
_______________________________________________
Lazarus mailing list
[email protected]
http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus

Reply via email to