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