StarMirror/styleguide
1
0
Fork 0
mirror of https://github.com/google/styleguide.git synced 2024-03-22 13:11:43 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #269 from google/update-objc

Browse Source 
[objc] Update the Objective-C style guide 📜
This commit is contained in:
Stephane Moore 2017-08-23 18:37:49 -07:00 committed by GitHub
commit 0c88671aa8
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
objcguide.md
View File

@ -29,10 +29,6 @@ example that should give you a feel for the style, spacing, naming, and so on.
Here is an example header file, demonstrating the correct commenting and spacing Here is an example header file, demonstrating the correct commenting and spacing
for an `@interface` declaration. for an `@interface` declaration.
Doxygen-style comments are encouraged for interfaces as they are parsed by Xcode
to display formatted documentation. There is a wide variety of Doxygen commands;
use them consistently within a project.
```objectivec ```objectivec
// GOOD: // GOOD:
@ -90,7 +86,7 @@ An example source file, demonstrating the correct commenting and spacing for the
#import "Shared/Util/Foo.h" #import "Shared/Util/Foo.h"
@implementation Foo { @implementation Foo {
// The string used for displaying "hi". /** The string used for displaying "hi". */
NSString *_string; NSString *_string;
} }
@ -882,6 +878,10 @@ categories, protocol declarations, and enums.
@end @end
``` ```
Doxygen-style comments are encouraged for interfaces as they are parsed by Xcode
to display formatted documentation. There is a wide variety of Doxygen commands;
use them consistently within a project.
If you have already described an interface in detail in the comments at the top If you have already described an interface in detail in the comments at the top
of your file, feel free to simply state, "See comment at top of file for a of your file, feel free to simply state, "See comment at top of file for a
complete description", but be sure to have some sort of comment. complete description", but be sure to have some sort of comment.
@ -1015,7 +1015,7 @@ Examples of strong and weak declarations:
IBOutlet NSButton *_okButton; // Normal NSControl; implicitly weak on Mac only IBOutlet NSButton *_okButton; // Normal NSControl; implicitly weak on Mac only
AnObjcObject *_doohickey; // My doohickey AnObjcObject *_doohickey; // My doohickey
MyObjcParent * __weak _parent; // To send messages back (owns this instance) __weak MyObjcParent *_parent; // To send messages back (owns this instance)
// non-NSObject pointers... // non-NSObject pointers...
CWackyCPPClass *_wacky; // Strong, some cross-platform object CWackyCPPClass *_wacky; // Strong, some cross-platform object