幾乎每個(gè)程序員都有接手維護(hù)別人遺留項(xiàng)目的經(jīng)歷。愛掏網(wǎng) - it200.com或者，有可能一個(gè)老項(xiàng)目某一天又被重新啟動(dòng)。愛掏網(wǎng) - it200.com 通常情況下，接手老項(xiàng)目都會(huì)讓人恨不得拋棄掉整個(gè)代碼庫從頭開始。愛掏網(wǎng) - it200.com老代碼凌亂、文檔缺失、需要研究很多天才能完全搞明白它。愛掏網(wǎng) - it200.com然而，通過合適的規(guī)劃、分解和 好的工作流，項(xiàng)目代碼可以變得干凈、有組織和可擴(kuò)展。愛掏網(wǎng) - it200.com
我曾經(jīng)接手清理許多項(xiàng)目的代碼，讓我不得不重頭開始的項(xiàng)目真心不多，不過我最近就遇到了一個(gè)。愛掏網(wǎng) - it200.com我從中學(xué)到了很多關(guān)于 JavaScript 代碼組織的內(nèi)容，以及最重要的是冷靜，不要為你的前任抓狂。愛掏網(wǎng) - it200.com在這篇文章里，我想要讓你知道我是怎么一步步處理項(xiàng)目代碼的，告訴你我的經(jīng)驗(yàn)。愛掏網(wǎng) - it200.com
分析項(xiàng)目
第一步是先概覽整個(gè)項(xiàng)目，弄明白問題所在。愛掏網(wǎng) - it200.com如果這是一個(gè)網(wǎng)站，通過點(diǎn)擊測(cè)試所有功能點(diǎn)：打開模塊、提交表單以及其他的。愛掏網(wǎng) - it200.com在做這件事的時(shí)候，打開開發(fā)者工具，看看是否有任何報(bào)錯(cuò)，看看控制臺(tái)有沒有日志。愛掏網(wǎng) - it200.com如果這是一個(gè)Node.js項(xiàng)目，打開命令行界面然后檢查各個(gè)API。愛掏網(wǎng) - it200.com最好的情況是項(xiàng)目通過統(tǒng)一的入口（例如：main.js,?index.js,?app.js, ……）來初始化所有的模塊，最差的情況是整個(gè)業(yè)務(wù)邏輯散落于各處。愛掏網(wǎng) - it200.com
搞清楚項(xiàng)目采用了哪些工具。愛掏網(wǎng) - it200.com是?jQuery、React?或是?Express？將所有重要的信息整理在一個(gè)清單里。愛掏網(wǎng) - it200.com假設(shè)這個(gè)項(xiàng)目是用?Angular 2?寫的，你之前對(duì) Angular 2 不熟悉，先去查看文檔，對(duì)它有一個(gè)初步的了解，并尋找最佳實(shí)踐的范例。愛掏網(wǎng) - it200.com
從更高層面上理解項(xiàng)目
了解技術(shù)點(diǎn)是一個(gè)好開端，但要進(jìn)一步深入理解，我們需要看一看它的單元測(cè)試。愛掏網(wǎng) - it200.com單元測(cè)試通過測(cè)試代碼的功能函數(shù)與方法來保證代碼如預(yù)期的那樣運(yùn)行。愛掏網(wǎng) - it200.com不同于僅僅閱讀代碼，查看和運(yùn)行單元測(cè)試能讓你更加深入理解代碼的期望運(yùn)行結(jié)果。愛掏網(wǎng) - it200.com如果接手的項(xiàng)目沒寫單元測(cè)試，沒關(guān)系，我們可以自己來寫。愛掏網(wǎng) - it200.com
創(chuàng)建基線
這樣做是為了確立一致性。愛掏網(wǎng) - it200.com你已經(jīng)了解了項(xiàng)目的工具鏈、代碼結(jié)構(gòu)、模塊的邏輯關(guān)系，現(xiàn)在該為項(xiàng)目創(chuàng)建基線了。愛掏網(wǎng) - it200.com我推薦添加一個(gè)?.editorconfig?文件讓代碼風(fēng)格在不同的編輯器、IED和不同的開發(fā)者之間保持一致。愛掏網(wǎng) - it200.com
一致的縮進(jìn)
使用 tab 還是空格來縮進(jìn)是一個(gè)老問題?，常引發(fā)程序員爭(zhēng)論不休，不過沒關(guān)系，不管項(xiàng)目用的是空格還是 tab，繼續(xù)使用之前的就好了。愛掏網(wǎng) - it200.com除非代碼庫既有空格縮進(jìn)又有 tab 縮進(jìn)的代碼，那就只好在兩者中做出一個(gè)取舍。愛掏網(wǎng) - it200.com每個(gè)人都可以保持自己的觀點(diǎn)，但一個(gè)好的項(xiàng)目要保證所有的開發(fā)者都可以無爭(zhēng)議地協(xié)同工作。愛掏網(wǎng) - it200.com
為什么這個(gè)很重要？因?yàn)槊恳粋€(gè)人都有自己使用編輯器或 IDE 的習(xí)慣。愛掏網(wǎng) - it200.com比如，我是個(gè)代碼折疊控，要是編輯器沒有正確的代碼折疊功能，我整個(gè)人都會(huì)迷失在文件里。愛掏網(wǎng) - it200.com如果代碼的縮進(jìn)不一致，就會(huì)影響到折疊功能，因此每一次我打開一個(gè)文件，不得不先修復(fù)那些縮進(jìn)然后才能開始工作，這十分浪費(fèi)時(shí)間。愛掏網(wǎng) - it200.com
// 雖然這段 JavaScript 代碼是合法的, 但這段代碼塊沒辦法正常折疊
// 因?yàn)檫@段代碼的縮進(jìn)不一致
function foo (data) {
let property = String(data);
if (property === 'bar') {
property = doSomething(property);
}
//... more logic.
}
// 修復(fù)縮進(jìn)后，這段代碼才可以被正確折疊
// 從而獲得更好的編碼體驗(yàn)和更整潔的代碼庫
function foo (data) {
let property = String(data);
if (property === 'bar') {
property = doSomething(property);
}
//... more logic.
}
命名
確保項(xiàng)目中使用命名約定是值得推崇的做法。愛掏網(wǎng) - it200.com駝峰命名通常在 JavaScript 代碼中使用，但是我看到過許多不一致的命名。愛掏網(wǎng) - it200.com例如：jQuery 項(xiàng)目經(jīng)常會(huì)有代碼在命名上混淆 jQuery 對(duì)象和其他對(duì)象。愛掏網(wǎng) - it200.com
// 不一致的命名讓代碼變得難以檢查和理解
// 它還會(huì)誤導(dǎo)維護(hù)者
const $element = $('.element');
function _privateMethod () {
const self = $(this);
const _internalElement = $('.internal-element');
let $data = element.data('foo');
//... more logic.
}
// 這樣改就更易于理解了
const $element = $('.element');
function _privateMethod () {
const $this = $(this);
const $internalElement = $('.internal-element');
let elementData = $element.data('foo');
//... more logic.
}
代碼檢查
之前所做的一切是在美化代碼，主要是讓它變得更易于檢查。愛掏網(wǎng) - it200.com接下來我們介紹保證代碼質(zhì)量的通用最佳實(shí)踐。愛掏網(wǎng) - it200.comESLint，JSLint，還有?JSHint?是目前最受歡迎的三個(gè) JavaScript 代碼檢查工具。愛掏網(wǎng) - it200.com我個(gè)人用 JSHint 最多，但我現(xiàn)在最喜歡 ESLint，主要是因?yàn)樗梢宰远x規(guī)則，也較早地支持了 ES2024。愛掏網(wǎng) - it200.com
一旦你開始代碼檢查，如果有很多錯(cuò)誤信息出現(xiàn)，立即修復(fù)它們。愛掏網(wǎng) - it200.com別跳過這些步驟，直到你的代碼檢查工具對(duì)你的代碼徹底滿意了。愛掏網(wǎng) - it200.com
升級(jí)依賴
升級(jí)依賴需要仔細(xì)些，如果你不注意依賴本身的升級(jí)帶來的一些變化，就很容易導(dǎo)致錯(cuò)誤。愛掏網(wǎng) - it200.com一些項(xiàng)目可能只能依賴某些庫的固定版本（例如：v1.12.5），而另一些則使用版本通配符（例如：v1.12.x）。愛掏網(wǎng) - it200.com如果你要快速升級(jí)依賴，你需要知道依賴模塊的版本號(hào)通常按如下規(guī)則建立：主版本.小版本.補(bǔ)丁。愛掏網(wǎng) - it200.com如果你對(duì)?semantic versioning?的方式不熟悉，我推薦你先閱讀 Tim Oxley 的這篇文章。愛掏網(wǎng) - it200.com
升級(jí)依賴沒有通用方法。愛掏網(wǎng) - it200.com每個(gè)項(xiàng)目是不一樣的，需要區(qū)別對(duì)待。愛掏網(wǎng) - it200.com升級(jí)依賴的補(bǔ)丁版本通常不會(huì)出什么問題，小版本一般也還OK。愛掏網(wǎng) - it200.com但如果你要升級(jí)依賴的主版本，你就需要仔細(xì)檢查版本升級(jí)帶來的改變。愛掏網(wǎng) - it200.com有可能 API 完全改變了，那樣你就得重寫你項(xiàng)目的一大堆代碼。愛掏網(wǎng) - it200.com如果非必要，我一般避免將依賴升級(jí)到下一個(gè)主版本。愛掏網(wǎng) - it200.com
如果你的項(xiàng)目使用?npm?來管理依賴，你可以很方便地使用?npm outdated?命令來檢查你的依賴是否已經(jīng)過時(shí)了。愛掏網(wǎng) - it200.com我用一個(gè)項(xiàng)目?FrontBook?來舉例說明，在這個(gè)項(xiàng)目里，我經(jīng)常升級(jí)所有的依賴：
如你所見，我這個(gè)項(xiàng)目里的依賴有很多主版本升級(jí)。愛掏網(wǎng) - it200.com我不會(huì)一次將他們?nèi)可?jí)，但是會(huì)一次升級(jí)一個(gè)。愛掏網(wǎng) - it200.com雖然這會(huì)耗費(fèi)許多時(shí)間，但這是確保不會(huì)出問題的唯一辦法（尤其是如果這個(gè)項(xiàng)目沒有任何測(cè)試）。愛掏網(wǎng) - it200.com
下面該干臟活了
我必須讓你知道的非常重要的一點(diǎn)是，清理代碼并不意味著需要移除和重寫大量的代碼片段。愛掏網(wǎng) - it200.com當(dāng)然，有時(shí)候這可能是唯一的解決辦法，但是這不應(yīng)該是你的首選方案。愛掏網(wǎng) - it200.comJavaScript 特別靈活，因此難以給出一般性的建議，通常情況下你必須對(duì)癥下藥。愛掏網(wǎng) - it200.com
建立單元測(cè)試
單元測(cè)試能保證你理解代碼是如何工作的，這樣避免一些意外導(dǎo)致錯(cuò)誤。愛掏網(wǎng) - it200.comJavaScript 單元測(cè)試的內(nèi)容足夠?qū)懥硪黄恼拢晕以谶@里不能詳細(xì)介紹。愛掏網(wǎng) - it200.com目前被廣泛使用的單元測(cè)試框架有?Karma、Jasmine、Mocha?以及?Ava。愛掏網(wǎng) - it200.com如果你還要測(cè)試你的用戶界面，Nightwatch.js?和?DalekJS?是適合瀏覽器自動(dòng)化測(cè)試的工具。愛掏網(wǎng) - it200.com
單元測(cè)試和瀏覽器自動(dòng)化測(cè)試的區(qū)別是，前者測(cè)試你的 JavaScript 代碼本身，來確保你所有的模塊和主要邏輯運(yùn)行無誤。愛掏網(wǎng) - it200.com后者，測(cè)試用戶界面，確保界面元素在正確的位置，且如預(yù)期地工作。愛掏網(wǎng) - it200.com
在你開始動(dòng)手重構(gòu)代碼之前，認(rèn)真對(duì)待單元測(cè)試，那樣你的項(xiàng)目的穩(wěn)定性將得到改善，而你甚至還沒有開始考慮可擴(kuò)展性。愛掏網(wǎng) - it200.com單元測(cè)試帶來的另一個(gè)好處是你不再需要無時(shí)無刻擔(dān)心你的改動(dòng)會(huì)無意中破壞原有功能。愛掏網(wǎng) - it200.com
Rebecca Murphey 寫了一篇很棒的文章關(guān)于如何為現(xiàn)有代碼寫單元測(cè)試。愛掏網(wǎng) - it200.com
架構(gòu)
JavaScript 架構(gòu)是另一個(gè)大話題。愛掏網(wǎng) - it200.com重構(gòu)和清理架構(gòu)歸結(jié)于你在這方面積累了多少經(jīng)驗(yàn)。愛掏網(wǎng) - it200.com我們可以選擇許多不同的設(shè)計(jì)模式，但不是所有的模式都適合于提升可擴(kuò)展性。愛掏網(wǎng) - it200.com限于篇幅，我不能涵蓋所有模式，但我至少可以給你一些通用的建議。愛掏網(wǎng) - it200.com
首先，你需要找出哪些設(shè)計(jì)模式在你的項(xiàng)目中已經(jīng)使用到了。愛掏網(wǎng) - it200.com閱讀有關(guān)這些模式的部分，確保它們?cè)陧?xiàng)目中使用上保持一致性。愛掏網(wǎng) - it200.com可擴(kuò)展性的關(guān)鍵之一便是堅(jiān)持一致的模式，避免混搭。愛掏網(wǎng) - it200.com當(dāng)然，你可以針對(duì)項(xiàng)目中的不同目的采用不同的設(shè)計(jì)模式（例如，將單例模式用于數(shù)據(jù)結(jié)構(gòu)和短命名空間的輔助功能函數(shù)，以及將觀察者模式用于與模塊），但是別對(duì)一個(gè)模塊使用了一種設(shè)計(jì)模式，對(duì)另一個(gè)模塊又用另一種不同的設(shè)計(jì)模式。愛掏網(wǎng) - it200.com
如果你的項(xiàng)目沒有任何架構(gòu)（可能一切都堆在一個(gè)巨大的app.js文件里），從現(xiàn)在開始讓它有架構(gòu)。愛掏網(wǎng) - it200.com不過別指望一口吃成 胖子，需要一點(diǎn)一點(diǎn)來。愛掏網(wǎng) - it200.com再次強(qiáng)調(diào)，沒有對(duì)任何項(xiàng)目都適用的萬精油方案，每一個(gè)項(xiàng)目的情況都是不同的。愛掏網(wǎng) - it200.com根據(jù)規(guī)模和復(fù)雜度不同，項(xiàng)目文件目錄結(jié)構(gòu)各有不同。愛掏網(wǎng) - it200.com通 常，最基本的原則是，目錄結(jié)構(gòu)應(yīng)當(dāng)將第三方庫、模塊、數(shù)據(jù)以及負(fù)責(zé)初始化模塊與邏輯的入口文件（比如：index.js、main.js）分開來。愛掏網(wǎng) - it200.com
簡(jiǎn)而言之就是模塊化。愛掏網(wǎng) - it200.com
將一切模塊化？
模塊化不是解決 JavaScript 擴(kuò)展性問題的唯一選擇。愛掏網(wǎng) - it200.com模塊化增加了一層 API，開發(fā)者不得不額外去熟悉它們。愛掏網(wǎng) - it200.com這雖然增加了麻煩，但是值得去做的。愛掏網(wǎng) - it200.com模塊化的基本原則是將所有功能拆分為小模塊。愛掏網(wǎng) - it200.com這么做了以后，不僅讓你更容易解決 代碼里的問題，也讓項(xiàng)目組的其他成員更容易協(xié)同工作。愛掏網(wǎng) - it200.com每個(gè)模塊只做一件事，它們不用關(guān)心外部邏輯，可以被復(fù)用在不同的地方。愛掏網(wǎng) - it200.com
如何將一大堆功能拆分成許多邏輯關(guān)聯(lián)的小模塊？讓我們來做做看：
// 這個(gè)例子使用 Fetch API 來請(qǐng)求一個(gè)服務(wù)器的 API
// 讓我們假設(shè)它返回一個(gè) JSON 文件，包含一些基本信息
// 然后我們創(chuàng)建一個(gè)新的元素，統(tǒng)計(jì) json 所有屬性的
// content 字段中的字符數(shù)，然后將結(jié)果插入 DOM 的某個(gè)位置。愛掏網(wǎng) - it200.com
fetch('https://api.somewebsite.io/post/61454e0126ebb8a2e85d', { method: 'GET' })
.then(response => {
if (response.status === 200) {
return response.json();
}
})
.then(json => {
if (json) {
Object.keys(json).forEach(key => {
const item = json[key];
const count = item.content.trim().replace(/\s+/gi, '').length;
const el = `
Total characters: ${count}
`;
const wrapper = document.querySelector('.info-element');
wrapper.innerHTML = el;
});
}
})
.catch(error => console.error(error));
上面的代碼不是模塊化的。愛掏網(wǎng) - it200.com所有的功能都耦合在一起。愛掏網(wǎng) - it200.com想象一下，如果這是更復(fù)雜的函數(shù)，由于出了一些錯(cuò)誤你必須調(diào)試它們，可能 API 沒返回，可能某些原因 JSON 內(nèi)部的值被改變或者別的什么問題。愛掏網(wǎng) - it200.com調(diào)試這一大坨代碼如同噩夢(mèng)般，不是嗎？
讓我們將代碼按不同的職責(zé)拆分開來：
function createWrapperElement (cssClass, content) {
const className = cssClass || 'default';
const wrapperElement = document.createElement('div');
const textElement = document.createElement('p');
const textNode = document.createTextNode(`Total characters: ${content}`);
wrapperElement.classList.add(className);
textElement.appendChild(textNode);
wrapperElement.appendChild(textElement);
return wrapperElement;
}
// 前一個(gè)例子 .forEach 中的匿名函數(shù)也被我們抽出來形成一個(gè)模塊
function appendCharacterCount (config) {
const wordCount = countCharacters(config.content);
const wrapperElement = createWrapperElement(config.className, wordCount);
const infoElement = document.querySelector('.info-element');
infoElement.appendChild(wrapperElement);
}
好了，我們現(xiàn)在有了三個(gè)新模塊，讓我們看看重構(gòu)之后的 fetch 調(diào)用：
fetch('https://api.somewebsite.io/post/61454e0126ebb8a2e85d', { method: 'GET' })
.then(response => {
if (response.status === 200) {
return response.json();
}
})
.then(json => {
if (json) {
Object.keys(json).forEach(key => appendCharacterCount(json[key]))
}
})
.catch(error => console.error(error));
當(dāng)然我們還可以進(jìn)一步將 .then( ) 中的邏輯也抽出來形成模塊，不過我想我已經(jīng)充分表達(dá)了模塊化的含義。愛掏網(wǎng) - it200.com
如果不想模塊化呢？
如我前面提到的，將你的代碼拆成小模塊會(huì)增加額外的一層 API。愛掏網(wǎng) - it200.com如果你不想這么做，但是又想要讓代碼易于與其他開發(fā)者一起維護(hù)，不拆函數(shù)也沒問題，你依然可以將你的代碼分解成更簡(jiǎn)單的部分并把重點(diǎn)放在可測(cè)試的代碼上。愛掏網(wǎng) - it200.com
為你的代碼撰寫文檔
文檔化是一個(gè)老生常談的話題。愛掏網(wǎng) - it200.com程序員社區(qū)的一部分人提倡將一切文檔化，而另一部分人認(rèn)為好代碼即是文檔。愛掏網(wǎng) - it200.com我奉行中庸之道，我覺得代碼的可讀和可擴(kuò)展之間需要保持平衡。愛掏網(wǎng) - it200.com你可以使用?JSDoc?來幫助你實(shí)現(xiàn)文檔化。愛掏網(wǎng) - it200.com
JSDoc 是一個(gè) JavaScript 的 API 文檔生成器。愛掏網(wǎng) - it200.com常用的編輯器和 IDE 都有支持它的插件。愛掏網(wǎng) - it200.com我們看一個(gè)例子：
function properties (name, obj = {}) {
if (!name) return;
const arr = [];
Object.keys(obj).forEach(key => {
if (arr.indexOf(obj[key][name])
這個(gè)函數(shù)有兩個(gè)參數(shù)，遍歷一個(gè)對(duì)象，返回一個(gè)數(shù)組。愛掏網(wǎng) - it200.com這也許不是一個(gè)過于復(fù)雜的方法，但是對(duì)于沒寫過這段代碼的人來說，搞懂它還是有點(diǎn)費(fèi)勁。愛掏網(wǎng) - it200.com此外，這個(gè)方法具體的作用也不是很明確。愛掏網(wǎng) - it200.com讓我們對(duì)它文檔化：
/**
* 遍歷一個(gè)對(duì)象，將將所有屬性對(duì)象的 'name' push 到一個(gè)新數(shù)組中
* 如果有重復(fù)，只 push 一次
* @param {String} propertyName - 屬性的名字
* @param {Object} obj - 你想要遍歷的對(duì)象
* @return {Array}
*/
function getArrayOfProperties (propertyName, obj = {}) {
if (!propertyName) return;
const properties = [];
Object.keys(obj).forEach(child => {
if (properties.indexOf(obj[child][propertyName])
我沒有改變?nèi)魏未a，只是改了一下函數(shù)名，添加了一段簡(jiǎn)短的注釋，就已經(jīng)讓這段代碼的可讀性變得好多了。愛掏網(wǎng) - it200.com
有條理的代碼提交工作流
重構(gòu)本身是一項(xiàng)艱巨的任務(wù)。愛掏網(wǎng) - it200.com為了能隨時(shí)回滾你的修改（假如你破壞了一些原有功能，過了一會(huì)才意識(shí)到，你可能就需要回滾代碼到之前版本），你的每一部 分修改，比如重寫了一個(gè)方法、重命名了一個(gè)名字空間，都應(yīng)該及時(shí)提交到 git （或者 svn）。愛掏網(wǎng) - it200.com這么做也許會(huì)讓你覺得麻煩，但這么做有助于讓你的清理工作更有條理。愛掏網(wǎng) - it200.com
為你的重構(gòu)工作開一個(gè)新的分支，千萬別總是在主線 (master) 上改。愛掏網(wǎng) - it200.com因?yàn)橹骶€版本你有可能需要臨時(shí)做一些更新或者隨時(shí)發(fā)布一些 bug fixes 到線上環(huán)境，而你又不能將你沒有經(jīng)過測(cè)試的和未完成的重構(gòu)一同發(fā)布到線上，因此我建議你還是應(yīng)該在不同的分支上工作。愛掏網(wǎng) - it200.com
在 GitHub 上有一份有趣的指導(dǎo)，是關(guān)于如何使用他們的版本控制流程的。愛掏網(wǎng) - it200.com
別失去理智
除了用技術(shù)解決問題之外，有一個(gè)很重要的點(diǎn)很少被人提及：別為你的前任抓狂。愛掏網(wǎng) - it200.com我無意指責(zé)任何人，但是我知道一些人經(jīng)歷過這種情況。愛掏網(wǎng) - it200.com我花了很多年的時(shí)間去理解和克服心理上的不爽。愛掏網(wǎng) - it200.com我曾經(jīng)對(duì)前任開發(fā)者們留下的代碼、解決方案感到有些抓狂，他們做的一切在我眼里看來都造成混亂。愛掏網(wǎng) - it200.com
結(jié)果，這些消極情緒沒帶給我任何好處。愛掏網(wǎng) - it200.com消極情緒會(huì)導(dǎo)致你過度重構(gòu)，浪費(fèi)你的時(shí)間，而且可能破壞一些原有功能，而這一切又導(dǎo)致你越來越惱怒。愛掏網(wǎng) - it200.com你可能會(huì) 花費(fèi)額外的時(shí)間去重寫一個(gè)本來毫無問題的模塊，沒有人會(huì)因此感謝你，因?yàn)槟阍谧鰺o用功。愛掏網(wǎng) - it200.com先分析狀況，然后做有價(jià)值的重構(gòu)。愛掏網(wǎng) - it200.com在任何時(shí)候，你隨時(shí)可以對(duì)一個(gè)模 塊做一些細(xì)節(jié)的改進(jìn)。愛掏網(wǎng) - it200.com
一段代碼為什么寫成這樣往往是有歷史原因的，也許前任程序員沒有足夠的時(shí)間將代碼寫得足夠好、或者不知道有更好的寫法，或者別的什么原因。愛掏網(wǎng) - it200.com我們都是過來人。愛掏網(wǎng) - it200.com
整理一下
讓我們從頭回顧一下所有的步驟，為你的下一個(gè)項(xiàng)目創(chuàng)建一個(gè) checklist：
- 分析項(xiàng)目
- 先忘掉自己的開發(fā)者身份，以一個(gè)用戶的身份來看清它的全貌。愛掏網(wǎng) - it200.com
- 瀏覽代碼庫，列出項(xiàng)目使用的工具。愛掏網(wǎng) - it200.com
- 閱讀項(xiàng)目相關(guān)工具的文檔和最佳實(shí)踐。愛掏網(wǎng) - it200.com
- 瀏覽單元測(cè)試，從更高層面上了解項(xiàng)目。愛掏網(wǎng) - it200.com
- 創(chuàng)建基線
- 引入?
.editorconfig?以保證在所有的編輯器和 IDE 下保持代碼風(fēng)格一致。愛掏網(wǎng) - it200.com
- 使縮進(jìn)風(fēng)格一致，至于是用 tab 還是空格，無所謂。愛掏網(wǎng) - it200.com
- 執(zhí)行命名約定。愛掏網(wǎng) - it200.com
- 如果代碼檢查工具不存在, 添加一個(gè)，可以是?ESLint、?JSLint?或者?JSHint。愛掏網(wǎng) - it200.com
- 升級(jí)依賴，但是需要格外小心，弄清楚到底升級(jí)了什么。愛掏網(wǎng) - it200.com
- 清理代碼
- 建立單元測(cè)試與瀏覽器自動(dòng)化測(cè)試，可以使用一些工具，例如?Karma、Jasmine、或者?Nightwatch.js。愛掏網(wǎng) - it200.com
- 確保架構(gòu)和設(shè)計(jì)模式保持一致。愛掏網(wǎng) - it200.com
- 不要混用?設(shè)計(jì)模式，堅(jiān)持使用已經(jīng)存在的設(shè)計(jì)模式。愛掏網(wǎng) - it200.com
- 決定你是否需要將代碼庫拆分成模塊。愛掏網(wǎng) - it200.com每一個(gè)模塊應(yīng)當(dāng)具有單一的目的，模塊不用關(guān)心自身之外的其他邏輯。愛掏網(wǎng) - it200.com
- 如果你不想拆分模塊，把重點(diǎn)放在可測(cè)試的代碼上，把它們分解成更簡(jiǎn)單的代碼塊。愛掏網(wǎng) - it200.com
- 恰當(dāng)?shù)孛愕暮瘮?shù)，為代碼適當(dāng)撰寫文檔，保持可讀和可擴(kuò)展的平衡。愛掏網(wǎng) - it200.com
- 使用?JSDoc?來生成文檔。愛掏網(wǎng) - it200.com
- 定期提交代碼，特別在有重要改變時(shí)。愛掏網(wǎng) - it200.com這樣如果有什么改錯(cuò)了，可以方便回滾。愛掏網(wǎng) - it200.com
- 別失去理智
- 別為你的前任開發(fā)者抓狂。愛掏網(wǎng) - it200.com負(fù)面情緒只會(huì)導(dǎo)致過度重構(gòu)而浪費(fèi)時(shí)間。愛掏網(wǎng) - it200.com
- 一段代碼為什么寫成這樣總是有原因的。愛掏網(wǎng) - it200.com要牢記我們都是過來人。愛掏網(wǎng) - it200.com
我非常希望這篇文章能幫到你。愛掏網(wǎng) - it200.com如果你正在為代碼重構(gòu)做這些努力，或者你有一些我沒有提到過的好建議，我希望你可以告訴我。愛掏網(wǎng) - it200.com
為了學(xué)習(xí)工作與休閑娛樂互不沖突，現(xiàn)新建圈【碼農(nóng)茶水鋪】用于程序員生活，愛好，交友，求職招聘，吐槽等話題交流，希望各位大神工作之余到茶水鋪來喝茶聊天。愛掏網(wǎng) - it200.com了解更多