Convetionals about comments for maintaining source code
"//!" - special comment, notes for developers
"//! ?" - questions
"//! N" - changes, some notes, N - numeric
"//! tmp" - temporary note
"//! exp" - experimental
"//! old" - old peace
"//! new" - new piece
"//! impl" - need to implement
"//! check" - need to check
"//! next" - what is to be done next
"//! future" - need to realize in future, next release
"//! todo" - to-do line (like "next")
"//! error" - place with error, need to see as soon as possible
"//! del" - need to delete
Coding style convention
Constants
- case: pascal
- format:[type]text, for example: AssertionNilObjectRecieved
Class, Protocol
- case: pascal, between words use underscore
- base class: no words like Abstract, Base.. just self-described words, for example: FunctionArgument
- may use underscore
Category:
- case: pascal
- use for name: *ing
Function:
- case: c-style aaa_bbb_cc
Define:
- case: upppercase with underscore