1. 程式人生 > >C/C++編程規範——文件頭註釋

C/C++編程規範——文件頭註釋

module sam 原則 date amp 公司 英文 手寫 基本

下面是我在C/C++編程時的文件頭註釋規範,基本上是參照各家公司的。

/************************
Module Name: <File name>
Project: <Sample name>
Copyright (c) Ada Co., Ltd. 1815-2017. All rights reserved.
Author:
ID: (工號)
Version:
Date:
Description:
Others: (有的話就寫,沒有就略去)
History: (有的話就寫,沒有就略去)
1. Date:
    Author:
    Modification:
2. Date:
    Author:
    Modification:
…
*************************/

註意:只有這裏的註釋使用/**/這種方式,其他地方都是使用雙斜杠//。註釋內容盡量使用英文。原則上要為每一份手寫代碼文件加入文件頭註釋。

C/C++編程規範——文件頭註釋