Re: Help understanding Apple's approach in documentation a little better.
Re: Help understanding Apple's approach in documentation a little better.
- Subject: Re: Help understanding Apple's approach in documentation a little better.
- From: Mike Abdullah <email@hidden>
- Date: Sun, 16 Aug 2015 22:27:33 +0100
> On 16 Aug 2015, at 22:18, Alex Zavatone <email@hidden> wrote:
>
>
> On Aug 16, 2015, at 4:49 PM, Ken Thomases wrote:
>
>> On Aug 16, 2015, at 3:09 PM, Alex Zavatone <email@hidden> wrote:
>>
>>> So, I look at UIStoryboard.h and the docs and see that there are 3 methods. No properties.
>>
>>> And in using it, I find out that in addition to the 3 methods within UIStoryboard.h, inside a an instance of UIStoryboard, there are a bunch of properties that appear to be stupidly useful.
>>>
>>> Like so:
>>> designatedEntryPointIdentifier
>>> identifierToNibNameMap
>>> storyboardFileName
>>> name
>>> bundle
>>
>>> This is really great. I can see if any of my view controllers' scenes' identifiers are misspelled, I can see what Cocoa's using and verify where or if I screwed up somewhere.
>>>
>>> This is really useful information.
>>>
>>> Why isn't it in Apple's documentation for storyboards?
>>
>> Because these are private implementation details. They are subject to change without notice. You can't rely on them in any shipping code.
>
> If they were private shouldn't there be a naming convention that states they are private?
>
> If I look at an instance of a storyboard object in the Variables View in the Debugger, I can expand the object and they are all listed.
>
> Is there some sort of naming or visual convention that communicates "you might be see these, but they're private and not for you to mess with"?
>
> As soon as I saw them exposed by the runtime tool, and I saw that expanding the storyboard instance exposed them, I thought that the docs and header files were hiding information that was accessible.
>
> Is there anything that shows that they are private?
Yes, whether they’re in the header or not! And even then, any instance variables that appear in headers are almost always marked as private there, either using @private or a comment, depending on the age of the code.
_______________________________________________
Cocoa-dev mailing list (email@hidden)
Please do not post admin requests or moderator comments to the list.
Contact the moderators at cocoa-dev-admins(at)lists.apple.com
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden