3. Comment on specifications and naming rules. Comment on standardized naming rules.

Source: Internet
Author: User

3. Comment on specifications and naming rules. Comment on standardized naming rules.

1. For C/C ++ files, the file header should have a comment similar to this:

/*************************************** *********************************

*

* File name: network. c

*

* File Description: network communication function set

*

* Created by: Hao Chen, December February 3, 2003

*

* Version: 1.0

*

**************************************** ********************************/

2. For functions, there should be comments similar to the following:

/* ===================================================== ======================================

*

* Letter count: XXX

*

* Parameter: type name [IN]: descripts

*

* Function description:

*

* Return value: TRUE for success, FALSE for failure

*

* Prepared by: ChenHao 2003/4/2

*

========================================================== ======================================= */

3,

 

Related Article

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: info-contact@alibabacloud.com 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.