[phobos] Initial Phobos style guide proposal

Jacob Carlborg doob at me.com
Thu Mar 31 11:16:16 PDT 2011


On 31 mar 2011, at 17:25, David Simcha wrote:

> 
> 
> On Thu, Mar 31, 2011 at 11:21 AM, Jacob Carlborg <doob at me.com> wrote:
>> 
>> - All public declarations should have proper ddoc documentation.
> 
> And protected methods as well, they're a part of the API just as much as the public methods.
> 
> 
> Somewhat agree, but sometimes you make a protected method to be overridden internally in your hierarchy, but it's not designed to be messed with by external clients.  Omitting ddoc for it sends a strong "don't mess with this" message.
> _______________________________________________
> phobos mailing list
> phobos at puremagic.com
> http://lists.puremagic.com/mailman/listinfo/phobos


That's true. Would that be worth a comment (not doc comment) saying it's only for internal use?

-- 
/Jacob Carlborg

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.puremagic.com/pipermail/phobos/attachments/20110331/fd8c8fec/attachment.html>


More information about the phobos mailing list