Should you use "internal abbreviations" in code comments?

Posted by Anto on Programmers See other posts from Programmers or by Anto
Published on 2011-04-11T20:34:45Z Indexed on 2012/03/22 23:37 UTC
Read the original article Hit count: 385

Should you use "internal abbreviations/slang" inside comments, that is, abbreviations and slang people outside the project could have trouble understanding, for instance, using something like //NYI instead of //Not Yet Implemented?

There are advantages of this, such as there is less "code" to type (though you could use autocomplete on the abbreviations) and you can read something like NYE faster than something like Not Yet Implemented, assuming you are aware of the abbreviation and its (unabbreviated) meaning.

Myself, I would be careful with this as long as it is not a project on which I for sure will be the only developer.

© Programmers or respective owner

Related posts about documentation

Related posts about comments