Skip to content

Commenting style guide

oztune edited this page Oct 3, 2011 · 1 revision

Pixelwave uses the AppleDoc tool to generate all of the Objective-C documentation. Visit AppleDoc's documentation area to learn more about the syntax involved.

Pixelwave commenting conventions

  • Properties are commented in the header file
  • Elements which are defined completely in the header are commented in the header
  • All other elements (Class, method, etc) are commented in the implementation (.m) file