ch1編程之道--代碼風(fēng)格的重塑(參考版)
2025-05-18 05:34本頁面
【正文】 。 如無重要理由，正式代碼庫中應(yīng)予以刪除。供外部工具使用的特殊標(biāo)記 如給 oxygen提取文檔用但標(biāo)記 7。廢棄代碼，替換代碼及相關(guān)說明。單句語句注釋 通常的注釋，用單行，附尾或 /**/ 5。函數(shù)內(nèi)代碼結(jié)構(gòu)注釋 。關(guān)鍵算法注釋 （成塊） 用一段話表示大體的結(jié)構(gòu)，可以放在文件頭或合適的位置。文件頭注釋，函數(shù)頭注釋。 1. 編程之道 代碼風(fēng)格的重塑 我的個人注釋風(fēng)格 (cont.) ? //++{{ [wjchen]: new codes here. //++ }} 1. 編程之道 代碼風(fēng)格的重塑 純粹視覺效果 ? 1. 文件幾大功能區(qū)分界線 ? //////////////////////////////// ? // PART I. MACRO DEFINIATION ? //////////////////////////////// ? 2. 函數(shù)定義分界線。 axGetNetName(cellId, flatNetId, amp。flatNetName)。 ? 用 //XX 表示廢棄的說明 ? 用 //(_) 表示需要表示需要注意的地方 （像一張睜大眼睛（或帶著眼鏡）的臉） 或簡寫作 ? 用 //?? 表示可能有問題的代碼。但很多文檔不在代碼庫中，因此在代碼中直接做一個簡單解釋，有利于快速閱讀代碼。有利于程序閱讀。尤其是已發(fā)布版本的修訂版。 ? 在另外一些版權(quán)，如 GPL ? 也有些會在項目目錄里有個專門的 COPYRIGHT文件 /**************************************************************************** * * * ACOMPANY CONFIDENTIAL * * * * This is an unpublished, proprietary work of ACOMPANY, Inc., and is * * fully protected under copyright and trade secret laws. You may not view, * * use, disclose, copy, or distribute this file or any information contained * * herein except pursuant to a valid written license from ACOMPANY. * * * *****************************************************************************/ /**************************************************************************** This file is part of the Open Babel project. This is copyright under the GNU General Public License (GPL) For more information, see *****************************************************************************/ 1. 編程之道 代碼風(fēng)格的重塑 文件信息 /******************************************************************************* ** ** FILE NAME: ** ** MODULE: System dependencies header ** ** ABSTRACT: This header holds the information programs need to ** know concerning O/S, hardware, and other system level thangs. ** ** CONVENTIONS: ** Use lower case for all O/S amp。 ? 簡述數(shù)據(jù)結(jié)構(gòu)和概要，并說明詳盡文檔編號。 1. 編程之道 代碼風(fēng)格的重塑 空行 ? 每個函數(shù)定義之間至少空兩行 ? 函數(shù)分界處除空行外，可以加注釋行分割 ? 如 // ? /////////////////////////////// ? //=================== ? 函數(shù)內(nèi)部重要分界處可以空一行 1. 編程之道 代碼風(fēng)格的重塑 注釋 ? 注釋的原則 ? 可以不注釋就不注釋（讓代碼自己說明） ? 需要注釋一定注釋。 dbIteratorId_t iterId。 axPortInst_t *portInst。 應(yīng)改為： dbObjId_t CIMId, PoIMId, cellInstId, portInstId。 dbIteratorId_t iterId。 axPortInst_t *portInst。 dbObjId_t CIMId, PoIMId, cellInstId, portInstId。 定義時同類型變量之間用逗號和一個空格隔開。在適當(dāng)?shù)臅r候加花括號可以避免內(nèi)部變量范圍過大。每部分可以單獨折疊，方便代碼閱讀。hierPortInst) || !hierPortIns
教學(xué)課件相關(guān)推薦
鄂ICP備17016276號-1