Code Reconstruction ~ Code comment

ArticleDirectory

•  
• 7. Code comments

A goodProgramA readable program must have a good comment! An excellent team and an efficient team are inseparable from a standardCodeAnnotations.

Code comments-try to make the code comments clear and complete, and indicate the functions, creators, modifier, and time of the Code.

The Code is as follows:

 1          # Region Code comment 2           ///   <Summary>  3           ///  Data operation base class  4           ///  </Summary>  5           ///   <Remarks>  6           ///  Created by: Zhang zhanling  7           ///  Created Date: 2012-1-1  8           ///  Modify:  9           ///  Modify Date:  10          ///  Modify reason:  11           ///   </Remarks>  12           Class  Repositorybase  13   {  14            //  ...  15   }  16           # Endregion 

 

Code refactoring directory 1 encapsulate the member variable (encapsulate field) 2 extract method (Extract Method) 3 extract to class (extract class) 4 method back to parent (method move up) 5. Method normalization (method downward) 6. Method renaming 7. Code comment