LLVM Coding Standards
spir
denis.spir at gmail.com
Tue Apr 12 02:50:32 PDT 2011
On 04/11/2011 09:58 PM, spir wrote:
> I'm reading (just for interest) the LLVM Coding Standards at
> http://llvm.org/docs/CodingStandards.html. Find them very interesting because
> their purposes are clearly explained. Below sample.
I also love their note about naming:
====================================
Name Types, Functions, Variables, and Enumerators Properly
Poorly-chosen names can mislead the reader and cause bugs. We cannot stress
enough how important it is to use descriptive names. Pick names that match the
semantics and role of the underlying entities, within reason. Avoid
abbreviations unless they are well known. After picking a good name, make sure
to use consistent capitalization for the name, as inconsistency requires
clients to either memorize the APIs or to look it up to find the exact spelling.
====================================
Dunno who the author is, anyway this text is great. I even appreciate points I
totally disagree with, because their *purpose* is properly xplained &
argumented: thus, discussion can nicely follow on good bases. It looks like if
one can logically show them where & why they are wrong, they will actually
change their mind (a rare event in disussions among programmers, esp. about
coding guidelines ;-).
Denis
--
_________________
vita es estrany
spir.wikidot.com
More information about the Digitalmars-d
mailing list