資訊專欄INFORMATION COLUMN
摘要：之前自己寫代碼，就像一盤散沙，完全沒有一種規范。經過最近一段時間的開發，和對一些注釋風格的參考，形成了自己想去使用的注釋規范。如果變量注釋有點長，就不太好了。
之前自己寫代碼，就像一盤散沙，完全沒有一種規范。這種自由，會讓自己寫的東西時常變化。也很不利于團隊協作開發。經過最近一段時間的開發，和對一些注釋風格的參考，形成了自己想去使用的注釋規范。
js的組織是模塊化，一個模塊對應一個js文件。
模塊功能描述說明：
/** * ------------------------------------------------------------------ * 模塊描述說明 * ------------------------------------------------------------------ */
我喜歡開始和結束各空一行，中間是描述內容。
模塊內的小函數方法歸類：
/** * 小函數方法歸類說明，這些零散的小函數方法放在一起 對應 一個業務方法邏輯 * ------------------------------------------------------------------ */
把一個業務方法中抽取出來的小函數放在一起，便于查找。
單個函數方法：
/**
* 函數功能簡述
*
* 具體描述一些細節
*
* @param {string} address 地址
* @param {array} com 商品數組
* @param {string} pay_status 支付方式
* @returns void
*
* @date 2014-04-12
* @author QETHAN
*/
開發中使用的是PhpStorm IDE, 每次創建一個js新文件，文件內容頭部會根據配置文件模板去自動加上一些注釋信息。我配置的是 日期 和 作者。現在是一個人開發，所以上邊注釋中的日期和作者 我一般不會在函數中去加上。但是，如果其他人參與進來了，自己修改的是別人的代碼，就要更新添加這些注釋信息。
單行注釋：
//這是一條單行注釋
有些人喜歡這樣 // 這是一條單行注釋 雙斜杠后邊會加一個空格。我不認同。喜歡干練清晰簡潔，在適合的時候，就一定會這樣做。
單個函數方法中變量注釋：
//商品屬性變量(一組變量描述)
//商品名字(單個變量注釋)
var name = $(item).find(".js-name").val(),
//商品數量
count = $(item).find(".js-count").text(),
//商品單價
price = $(item).find(".js-price").val();
有些喜歡注釋放在單個變量后邊。如果變量注釋有點長，就不太好了。放在上邊，比較省心，清晰。
單個函數方法中代碼片段注釋：
/* | 代碼片段的描述說明 */
if, foreach, addEventListener ... 這些代碼片段的時候
注釋中縮進 必須使用空格。保證各種環境下排版的一致性。
@use JSDoc
<持續維護更新...>
文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。
轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/78081.html
一、前言昨天一個朋友問：我的工作只有vue、react，了解其他的好像沒有太大作用。其實不然，前端要考慮的內容其實很多，不光是完成業務代碼。我司的一個控制臺前端維護人數在20+，如果每個人都在一個項目中開發，那么每天就等著構建了，不僅容易出錯，而且浪費時間，這對于線上項目是不可容忍的。前端項目有大有小，這里假設我們面對的是一個相對復雜的中臺系統，那么要考慮的東西是很多的。下面我列舉了大部分，如果有...
摘要：小駝峰式命名法首字母小寫。文件資源命名文件名不得含有空格文件名建議只使用小寫字母，不使用大寫字母。可執行不可執行判斷是否含有某個值函數返回一個布爾值。使用文檔聲明類型的作用是為了防止開啟瀏覽器的怪異模式。 本文首發于我的個人網站：http://cherryblog.site/ （背景更換了不知道大家有沒有發現呢，嘻嘻） 一個好的程序員肯定是要能書寫可維護的代碼，而不是一次性的代碼，怎么...
摘要：前言作為一名全干打字員，干活時經常會被要求使用各種各樣的語言去實現各種各樣的需求，來回切換起來寫的代碼就會或多或少有點不規范。今天我們以為例，講講在代碼中，我們需要注意的某些規范。 前言 作為一名全干打字員，干活時經常會被要求使用各種各樣的語言去實現各種各樣的需求，來回切換起來寫的代碼就會或多或少有點不規范。今天我們以JAVA為例，講講在代碼中，我們需要注意的某些規范。（本文標準依賴于...
閱讀 1660·2021-11-16 11:41
閱讀 2458·2021-11-08 13:14
閱讀 3106·2019-08-29 17:16
閱讀 3079·2019-08-29 16:30
閱讀 1843·2019-08-29 13:51
閱讀 356·2019-08-23 18:38
閱讀 3223·2019-08-23 17:14
閱讀 630·2019-08-23 15:09
