程式設計規範學習 1 注釋和命名

2022-07-15 03:03:11 字數 1202 閱讀 9756

既然準備好好的弄,就先把程式設計規範給學習下,先看華為的規範,從簡單的檔案注釋和命名開始,這2塊是最容易搞亂的,還是得堅持住,天天看,每次程式設計看一次,就不信還搞不定,下面摘下大概的規範內容,有部分修改了點。

注釋規範:檔案注釋

file name:     檔名

description:   用於詳細說明此程式檔案完成的主要功能

author:       作者

version:       版本  

date:         完成日期

history:       修改歷史記錄列表,每條修改記錄應包括修改日期、修改者及修改內容簡述。    

函式注釋:

function:              //  函式名稱

description:        //  函式功能、效能等的描述

called by:            //  呼叫本函式的函式清單

input:                    //  輸入引數說明,包括每個引數的作

//  用、取值說明及引數間關係。

output:                  //  對輸出引數的說明。

return:                  //  函式返回值的說明

others:                  //  其它說明

短注釋用「\\」,超過3行的注釋用「/*   */」來注釋,注釋內容要寫到被注釋內容的上面或者旁邊。

對於巨集定義、資料結構宣告要做明確的說明,資料結構要對結構內容的每一條做明確說明。

對於全域性變數,最好做到在乙個函式裡進行賦值和修改,並做好說明:變數的作用,取值範圍,以及哪些函式使用

對於檔案命名:雖然有很多種方法,不過方法太多就讓我不知道用哪種,所以用著用著就全部混亂了。還是選擇個合適的來規定自己,這樣就不怕混亂了。

函式命名:首字母大寫的方式,例:writedate();

巨集定義和資料型別:用全部大寫,例#define max 10

變數命名:用全部小寫加下劃線的方式,全域性變數前面帶g_(global),函式裡的靜態變數用s_(static),檔案內部的全域性變數則用l_(local) ,常量命名則用c_(const),還有資料型別,可以用u8,u16,u32,s8,s16,s32等表示,例:乙個u8的全域性變數,可以表示為gu8_,感覺有點怪,這個還是再考慮考慮

其他的後面再看,先把這部分堅持住了,大概也就差不多了。

rust 注釋和命名規範 2

行注釋是二個反斜槓 文件注釋是三個反斜槓 和 可以用cargo doc來生成html說明文件。和 使用位置有限制 rand 隨機數 rand 隨機數 extern crate rand test方法 fn test 變數識別符號和函式標識 符官方要求就是小寫加下劃線拼接的方式,常量 盡量遵循全大寫加...

程式設計命名規範以及函式檔案注釋

1.2.匈牙利命名法 1.3 下劃線命名法 1.4.命名例項 2 函式注釋 3 檔案注釋 除第乙個單詞之外,其他單詞首字母大寫 常用於變數 int mystudentnumber與小駝峰式命名法的最大區別在於,每個單詞的第乙個字母都要大寫。常用於類名,函式名,屬性,命名空間 class studen...

PHP注釋語法規範和命名規範

php裡面常見的幾種注釋方式 1.檔案的注釋,介紹檔名,功能以及作者版本號等資訊 檔名簡單介紹 檔案功能 author 作者 version 版本號 date 2020 02 02 2.類的注釋,類名及介紹 類的介紹 類的詳細介紹 可選 author 作者 version 版本號 date 2020...