提前認識軟體開發(6):程式的版式和注釋

來源:互聯網
上載者:User

第1部分 重新認識C語言

程式的版式和注釋

在《高品質程式設計指南(C/C++語言)》中,作者說:可以把程式的版式比喻為“書法”,好的“書法”可以讓人對程式一目瞭然,看得興緻勃勃。確實,我們一開啟程式,首先看到的便是程式的排版,我們的第一印象便是程式寫得是工整還是淩亂。都說第一印象很重要,為了給大家留下好的第一印象,我們一定要注重程式的版式。

此外,好的注釋能夠協助讀者更快地理解程式,提高工作的效率。也許是因為工作比較忙的緣故,很多軟體工程師不喜歡為自己的程式寫注釋,認為這樣做是沒有必要的。那麼,如果給他一份毫無注釋的代碼,他會有什麼樣的感受呢?在程式中,優美的、得當的注釋能夠起到錦上添花的作用,更能夠體現出一個工程師的專業素質。因此,寫注釋實在是很有必要的。

在C語言程式中,一般都包括了標頭檔(.h檔案)和實現檔案(.c檔案),它們的版式及注釋如下:

第一,標頭檔的版式和注釋。

標頭檔起到一個輔助的作用,簡要地反應出本程式的準系統。

一般說來,標頭檔的版式可採用以下的樣式:

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

*著作權 (C)2014,公司名稱。

*

*檔案名稱:

*內容摘要:

*其它說明:

*目前的版本:

*作   者:

*完成日期:

*

*修改記錄1:  //修改記錄,包括修改日期、版本號碼、修改人及修改內容等

*   修改日期:

*   版本號碼:

*   修改人:

*   修改內容:

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

#ifndef _XXX_H             //防止標頭檔被重複引用

#define _XXX_H

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

相關宏定義

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

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

相關結構體定義

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

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

本程式中出現的函數的聲明

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

#endif

相關文章

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

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.