Difference between revisions of "Cpp Coding Standards/CODEDOC/ClassResp"

From Apache OpenOffice Wiki
Jump to: navigation, search
m
m (standardize linking)
Line 1: Line 1:
Every class should have one cohesive responsibility (see [[../../Class_Design#One_Responsibility | CLSDESIGN:OneResp]]
+
Every class should have one cohesive responsibility (see [[../../CLSDESIGN#OneResp| CLSDESIGN:OneResp]]
 
). Express that in a precise statement.
 
). 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 14:32, 12 April 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?

Personal tools