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