Code Reconstruction ~ Code comment

Source: Internet
Author: User
    • 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

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.