規(guī)范化編程
編程的規(guī)范化與標(biāo)準(zhǔn)化在我們工程師的日常工作中占據(jù)了非常重要的地位,養(yǎng)成良好的習(xí)慣,樹立規(guī)范化和標(biāo)準(zhǔn)化的編程習(xí)慣對(duì)于提升工作效率,降低工作強(qiáng)度,降低日后維護(hù)難度,甚至對(duì)提高自己的職業(yè)素養(yǎng)都是不可或缺的,對(duì)于編程中的規(guī)范化,我認(rèn)為主要分為以下三個(gè)方面。 1、命名的規(guī)范化 命名的規(guī)范化的主要優(yōu)點(diǎn)是使我們的程序的可讀性增強(qiáng),讓我們的程序一目了然,同時(shí)方便記憶,提高工程師的編程效率,下面我們來(lái)詳細(xì)說(shuō)明如何規(guī)范的進(jìn)行命名。 上圖是程序中對(duì)輸出點(diǎn)Q0.1在符號(hào)表中的命名,該命名主要分為三個(gè)部分每個(gè)部分用"_"分隔開具體如下圖所示。 上圖就是命名的基本格式與步驟,在程序中的命名都應(yīng)該遵循這樣的命名原則。 2、程序的規(guī)范化編寫 不規(guī)范的程序編寫通常情況下也可以達(dá)到編程者所想實(shí)現(xiàn)的工序,但在某些特殊的條件下會(huì)造成意想不到的結(jié)果發(fā)生,下面我們舉例說(shuō)明 自鎖程序規(guī)范化說(shuō)明 (1)不規(guī)范程序示例 (2)規(guī)范程序編寫示例 3、程序注釋的規(guī)范化 規(guī)范的編寫程序注釋是一個(gè)合格工程師必備的素質(zhì),養(yǎng)成良好的對(duì)程序注釋的習(xí)慣,不僅能可以提高程序的可讀性,也方便了我們對(duì)程序的調(diào)試。下面我們來(lái)詳細(xì)說(shuō)明程序應(yīng)該如何注釋。 程序的注釋主要分為兩個(gè)部分,對(duì)程序塊的注釋,和程序塊中各個(gè)網(wǎng)絡(luò)的注釋,其中以對(duì)程序塊的注釋要求比較復(fù)雜,程序塊的注釋分為title和comment,title既是該程序塊的名稱,給程序起名的時(shí)候應(yīng)該盡量表達(dá)出該程序塊的功能,comment既是該程序塊的摘要,程序的摘要主要應(yīng)反應(yīng)出以下幾點(diǎn)內(nèi)容。 1、程序的概述,主要是該程序能完成的功能。 2、程序的作者。 3、程序的編寫時(shí)間。 4、程序的測(cè)試情況。 5、程序的版本,(格式為Vesion X.X,小改動(dòng)版本加0.1,大改 動(dòng),版本加1,每次改動(dòng)還要注明改動(dòng)的內(nèi)容) 上圖為程序塊注釋的標(biāo)準(zhǔn)格式。
|