如果您是專業(yè)的Web開發(fā)人員,那么在某種程度上,您可能需要維護另一位開發(fā)人員編寫的代碼塊或腳本。你花了幾個小時嘗試讀懂他的代碼?你的初步回答是“這是瘋了嗎?”如果你曾經聽說過另外一個團隊成員的名字用作描述壞代碼的動詞或形容詞,而你不想在某個時候成為那個人 - 你已經明白了寫清潔代碼的重要性。重慶網頁設計公司及重慶網站制作公司每個網站的代碼都是我們自己敲寫的,都具有非常高的可讀性、維護性。
作為開發(fā)人員,您不僅對代碼的結果負責,還對底層組件的完整性負責。創(chuàng)建一個符合目標的代碼塊是可能的(而且通常更快),否則這些代碼無法理解。遇到錯誤的代碼工作的截止日期 - 也就是說,直到您或另一個開發(fā)人員必須返回到更新代碼或更正錯誤的代碼。雖然創(chuàng)建干凈可讀的代碼在前端增加了一點時間和考慮,但一定會節(jié)省您的時間。當您敲擊您的下一個主題或插件時,請注意以下一些簡單的事情。
重點和意圖
當您清楚自己的發(fā)展方向和原因時,可以幫助您組織和維護干凈的代碼。嘗試將大量功能的代碼組合成更容易理解和維護的較小塊??梢元毩⑦\行的較小的邏輯塊將縮小錯誤的邊距與一個大的聯鎖文檔。
為了說明,想想一輛汽車。一輛汽車是由獨立的系統組成的一臺大型機器,一起工作,整體運行。如果你正在編寫一個模仿汽車的應用程序,理論上可以把每一行代碼都放在單個文件中,一個名為“car”的函數,但是這種方法并不認為汽車由發(fā)動機,變速器,輪子組成,車頭燈等。如果您需要在引擎上工作,則不會同時處理傳輸,所以將名為car.php的文件命名為一個名為車()所描述的(發(fā)動機,變速器,車輪,前大燈等)轎廂執(zhí)行的每一個操作。一個更好的方法是將汽車功能分解成更為集中的功能,如engine(),headlights()或wheel())。要進一步組織car.php,您可以將集中的功能移動到單獨的文件:engine.php,headlights.php等。最后,您會有更小的代碼塊,其意圖更加明確。你不需要挖整個車,只是修理車輪。
清晰度代碼注釋
我聽說很多開發(fā)商通過限制他們鍵入的字符數量來保護他們的亂碼,聲稱他們可以節(jié)省時間。這種節(jié)省時間的措施的形式是模糊的一個或兩個字母的變量名稱,不傳達其目的的函數名稱,或完全沒有注釋。代碼在編寫時可能被開發(fā)人員理解,但沒有其他人會有任何上下文。當一個星期或一個月后修改或重構這個代碼的時候,有人要解開混亂。這么多,以節(jié)省時間。
因為變量和函數可以被聲明為遠離它們所使用的許多行或文件,所以這些變量和函數的模糊名稱可以(并將會丟失上下文,如果它們不描述其目的),所以當編寫函數或變量名時,嘗試使用描述性文本將其保留在上下文中。一個名為“myFunction”的函數只傳達你(或其他人)寫了一個函數。相比之下,“myFunctionThatAddsTwoNumbers”是一個功能名稱,可以解釋它的作用。沒有進一步挖掘代碼,你知道該函數將添加兩個數字。這也擴展到變量; 如果你把艾菲爾鐵塔的緯度保存在一個變量上,一個好的名字就像“l(fā)atitudeOfTheEiffelTower”一樣?;蝾愃频臇|西描述變量包含什么。
提高代碼清晰度的另一種方法是使用注釋直接記錄。復雜的代碼具有很好的自我記錄命名仍然難以閱讀和理解,所以即使是一個小的評論也可以幫助其他開發(fā)人員了解。如果代碼由嵌套的條件語句或循環(huán)組成,那么對編程語言的熟悉并不總是足夠推導出應用于該問題的解決方案。一個簡短的評論來解釋一個陳述結束或描述一個部分如何與另一個部分相關聯,可以很大的方向來引導他人通過你的代碼很重要。想想它是寫下來,所以你不必以后再解釋一下。
編碼標準
如果您無法找出如何清理代碼,或者如果您有與同事進行格式化的語義參數,則可能會有一些文檔化的編碼標準,具體取決于您使用的技術。例如,WordPress有HTML,PHP,CSS和Javascript的指南。完全整合或包含WordPress等技術的編碼標準不僅可以清理您正在撰寫的代碼,還可以將其與社區(qū)的標準相一致 - 您可能會要求幫助,雇用或工作的社區(qū)。保存內容清潔和符合任何當前的編碼標準可以幫助您了解彼此。
好處
如果您發(fā)現自己犯有上述任何草率的代碼,我建議您使用上述建議作為清理代碼的起點。這將需要一些努力和小的時間投入,但是在這樣做的時候,你不僅會更加為自己的工作感到自豪,而且還會為自己和他人節(jié)省很多時間和頭痛。對于更有用的信息,您可以參考“ 清潔代碼:敏捷軟件工具手冊”進一步閱讀。