Support developer comments in Core Data model files and in xibs

Originator:atomicbird
Number:rdar://15484426 Date Originated:2013-11-15
Status:Open Resolved:
Product:Developer Tools Product Version:5.0.2
Classification:Enhancement Reproducible:Always
 
Tom Harrington 15-Nov-2013 03:39 PM

Summary:
Experienced developers know the value of well-commented code. It can make all the difference when reviewing someone else's code, or even when reviewing your own code six months later.

In any non-trivial Core Data model, a similar level of built-in documentation would be extremely useful. However the Core Data editor does not support this, so model files must be accompanied by external documentation.

Ideally:

- The data model inspector pane in Xcode would include a field labeled "comments", which could hold arbitrary text.
- This field would be available for every selectable item in the Core Data model editor, including entities, attributes, relationships, fetch requests, configurations, and any other selectable item I forgot to list here.

Tom Harrington 19-Nov-2013 10:12 AM

The comments above apply equally to xib files. When editing a xib, I should be able to add comments linked to specific UI elements, or to the document as a whole.

Comments


Please note: Reports posted here will not necessarily be seen by Apple. All problems should be submitted at bugreport.apple.com before they are posted here. Please only post information for Radars that you have filed yourself, and please do not include Apple confidential information in your posts. Thank you!