Beefy Boxes and Bandwidth Generously Provided by pair Networks
go ahead... be a heretic
 
PerlMonks  

Re^5: Documenting non-public OO components

by revdiablo (Prior)
on Sep 07, 2005 at 15:49 UTC ( #489901=note: print w/ replies, xml ) Need Help??


in reply to Re^4: Documenting non-public OO components
in thread Documenting non-public OO components

the library allows users, not just developers, to subclass that class. That wouldn't always be the case.

Wouldn't it? The view I take is that any time you have subclassed, you automatically become a developer. Is there any other reason to subclass than to extend or further develop a class?


Comment on Re^5: Documenting non-public OO components
Re^6: Documenting non-public OO components
by creamygoodness (Curate) on Sep 08, 2005 at 00:17 UTC
    If you subclass a class I don't want people outside the core development team to subclass, I'm not going to support you and I might just switch up the API on you without warning and break your app.

    I'd rather you didn't shoot yourself in the head, but I don't think it matters whether you label yourself a "user", a "developer", or a "devil's advocate" if you do.

    Now, if I put up a big "SUBCLASSING" heading then switched the API on you, I think you'd have a reasonable beef with me, since that can easily be interpreted as granting permission to subclass. So I'm only going to put up that heading when it's actually OK for anyone and their dog to subclass.

    But there are other ocassions where the development team may want to have a few classes which inherit. It's silly to abridge the documentation of the inheritance hierarchy just because you can't figure out a way to convey to users/non-core-developers/devil's-advocates that they shouldn't subclass while still documenting the way the class es work. The answer is, label it "PROTECTED API" or something similar.

    On large systems, the interface design is harder, more important, and more expensive than the low-level code...

    --
    Marvin Humphrey
    Rectangular Research ― http://www.rectangular.com

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://489901]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others having an uproarious good time at the Monastery: (14)
As of 2014-07-25 14:51 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    My favorite superfluous repetitious redundant duplicative phrase is:









    Results (172 votes), past polls