[OpenLayers-Trac] [OpenLayers] #853: Remove JSDOC from CLASS_NAME property
OpenLayers
trac at openlayers.org
Fri Nov 9 12:53:40 EST 2007
#853: Remove JSDOC from CLASS_NAME property
----------------------------+-----------------------------------------------
Reporter: euzuro | Owner:
Type: task | Status: closed
Priority: minor | Milestone: 2.5 Release
Component: documentation | Version: 2.4
Resolution: fixed | Keywords:
----------------------------+-----------------------------------------------
Comment (by tschaub):
Replying to [comment:5 euzuro]:
> Replying to [comment:4 tschaub]:
> > Post mortem comment: what was wrong with the nice ND style Constant
comment?
>
> The general consensus was that commenting those was really just
unnecessary: it doesn't particularly help us to have them show up in the
ND api docs, and it certainly doesn't help in the actual code itself.
Those are really just there for debugging purposes (and ocasionally as a
basis for id generation).
For what it's worth, I consider CLASS_NAME to be a critical property of OL
objects. Since we can't rely on the constructor property and the
instanceof operator isn't useful in all situations, CLASS_NAME is our key
for determining what our objects are instances of. Granted, it's a flaky
thing to rely on (because we are prone to typos), but I think it should be
treated as a first class citizen (tested, documented, etc). Note that
none of the vector/geometry code would work without it. And if anybody is
interested in object serialization (the context sandbox), that code relies
heavily on it.
Anyway, just more post mortem comments.
--
Ticket URL: <http://trac.openlayers.org/ticket/853#comment:10>
OpenLayers <http://openlayers.org/>
A free AJAX map viewer
More information about the Trac
mailing list