Difference between revisions of "Cpp Coding Standards/CODEDOC/ClassResp"
From Apache OpenOffice Wiki
m |
|||
Line 1: | Line 1: | ||
− | Every class should have one cohesive responsibility (see CLSDESIGN: | + | Every class should have one cohesive responsibility (see [[../../Class_Design#One_Responsibility | 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? | 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? |
Revision as of 22:21, 7 January 2007
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?