Difference between revisions of "Cpp Coding Standards/CODEDOC/ClassResp"
From Apache OpenOffice Wiki
m (Cpp Coding Standards/Code Documentation/ClassResp moved to Cpp Coding Standards/CODEDOC/ClassResp: consistency) |
B michaelsen (Talk | contribs) |
||
Line 3: | Line 3: | ||
A class normally is more complex than can be expressed in one name. Therefore most times a comment is necessary. There may be very few cases where this is unnecessary. But in most cases it is necessary, like for a class “String”: Is it an ASCII String or Unicode? Is it static or allows manipulation? | A class normally is more complex than can be expressed in one name. Therefore most times a comment is necessary. There may be very few cases where this is unnecessary. But in most cases it is necessary, like for a class “String”: Is it an ASCII String or Unicode? Is it static or allows manipulation? | ||
+ | [[Category:Coding Standards]] |
Latest revision as of 17:06, 14 December 2009
Every class should have one cohesive responsibility (see CLSDESIGN:OneResp ). Express that in a precise statement.
A class normally is more complex than can be expressed in one name. Therefore most times a comment is necessary. There may be very few cases where this is unnecessary. But in most cases it is necessary, like for a class “String”: Is it an ASCII String or Unicode? Is it static or allows manipulation?