Commenting style
Commenting style
- Subject: Commenting style
- From: Chad Armstrong <email@hidden>
- Date: Wed, 1 Mar 2006 20:18:40 -0600
Over the years, we take on particular coding styles, which evolve
over the years and adapt to the tools and languages we use.
Especially with C-based languages, I feel fairly happy with how my
code looks. However, is there a particular style used in Cocoa/
Objective-C for creating comments, especially with function/method
headers?
In Java, they are somewhat particular in how the header comments are
structured, and C# seems to have its own set of ways that things are
created, which can be very useful in generating documentation for
classes.
Is there any such rule of thumb in Cocoa?
Current, my headers tend to be formatted like this:
// =================
// Function name
// ----------------------------------
// Description about the function
// ----------------------------------
// Created date:
// Version date:
// =================
And if applicable, put in things like the Author.
- Chad
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Cocoa-dev mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden