Skip to content

Comment Formatting

Elias Watson edited this page Dec 3, 2018 · 1 revision

File Header

// --------------------
// Filename
// Maintainers
// List of contents (class names suffice)
// --------------------
<Newline>
<File Contents>

Class Header

// Classname
// Describe the purpose/use of the class
<Class Definition>

Instance Variable Header

<Newline>
// Describe what the variable is used for
<Variable Definition>

Method Header

<Newline>
// Describe what the method does
// List arguments and describe their purpose if necessary
// Describe the return value if necessary

Clone this wiki locally