[Lazarus] comments in source [Re: "show declaration hints" has more power in it than is really used]

Bernd prof7bit at googlemail.com
Sat Jul 24 14:24:15 CEST 2010


Also I have noticed that in many of the rare occasions where a class
has a documentation like here:

  { TSynTextFoldAVLTree
    Nodes in the tree cover the folded lines only
    the cfCollapsed line at the start of a fold, is *not* part of a node.
    RemoveFoldForline has special precaution for this.
  }

  TSynTextFoldAVLTree = class

It is used the wrong way. The empty line will make make the comment
effectively invisible for the hint- or help system and also there are
many comments that consist only of the name of the class that follows
afterwards:

  { TSynFoldNodeInfoHelper }

  TSynFoldNodeInfoHelper = class

SUCH comments are indeed annoying because they are not only redundant,
they are completely unnecessary. The abuse of comments as some kind of
 "bookmarks" or separators to be able to quickly scroll until the next
green line appears and something ends and something else starts serves
no purpose. Therefore better tools exist. Comments are meant to
*explain* things, not to draw horizontal lines into the code that are
only meant as separators and to be visible during fast scrolling from
2 meters distance.




More information about the Lazarus mailing list