今天,我們來看看標準化代碼編寫的要求。
希望通過閱讀這篇文章,可以提高對代碼規範的理解。
1.保證代碼壓縮後不會出錯。對於大型JSP項目,當產品發布時,項目中包含的所有JSP文件通常都是壓縮的。例如,可以使用GoogleClosureCompilerService壓縮代碼。jQuery的新版本使用了這個工具來壓縮代碼,它通常會刪除開發過程中編寫的註釋,並刪除所有空格和換行符。妳甚至可以用壹個短而無意義的變量名來代替原來的長變量名。這樣做的目的是為了加快文件的下載速度,同時減少網站訪問帶來的額外數據流量。另外也起到了壹點代碼保護的作用,至少壓縮後的代碼即使還原後也不那麽好讀了。
為了讓代碼正確地通過壓縮,通常要求語句應該以分號正常結束,大括號應該嚴格結束,等等。,取決於壓縮工具的要求。
所以如果壹開始不按標準做,壓縮錯誤後再回去找錯誤,那就是浪費時間。
2.確保代碼可以通過特定IDE的自動格式化功能。壹般比較完善的開發工具(如AptanaStudio)都有代碼“自動格式化”的功能,有助於實現換行符、縮進、空格等統壹的代碼排列。可以設置自己喜歡的格式標準,比如開大括號{是否另起壹行?
實現這壹要求的目的是為了方便開發團隊成員獲取代碼的副本,並使用IDE自動將其格式化為他們喜歡或熟悉的樣式。
妳的同事需要看妳的代碼,可能是因為妳寫了壹個通用的方法,他也需要用在其他模塊的開發中。閱讀妳的代碼可以深入了解方法調用和實現的細節,這是簡單的API文檔無法達到的效果。
3.使用標準文檔註釋的要求是基本的,有利於在方法調用處看到方法的具體參數。您還可以使用支持文檔工具來生成html或其他格式的開發文檔,供其他團隊成員閱讀。可以試試用jsdoc-toolkit。
如果妳自動生成的API來自壹個開放平臺,就像facebook.com應用程序壹樣,那麽妳的文檔是為全世界所有開發者準備的。
此外,編寫完整的註釋更便於團隊成員閱讀您的代碼。通過妳的參數描述,團隊成員可以很容易地知道妳寫的方法的細節,並參與實現。
當然也方便以後的代碼維護,這樣即使是大項目,時間長了,回去改東西的時候也不會忘記當時寫的東西。
4.使用標準化且有意義的變量名。使用標準化且有意義的變量名可以提高代碼的可讀性。作為大型項目開發的壹員,自己寫的代碼不僅要讓別人容易理解。
計算機培訓/以為大型項目的開發,其實大家可能都寫了大量的代碼,規範的命名,後來回頭看看自己的代碼也是清晰易懂的,比如以後系統升級或者新增功能,修改代碼就容易多了。
如果妳現在發現自己連當初寫的代碼都看不懂,那就大錯特錯了。