資訊專欄INFORMATION COLUMN
摘要：同時(shí)，個(gè)人感覺一個(gè)好的文檔也非常非常重要，會(huì)極大提高團(tuán)隊(duì)的效率。每一個(gè)都有每一個(gè)的業(yè)務(wù)作用，它的設(shè)計(jì)一定是根據(jù)業(yè)務(wù)邏輯來的，包括表的字段設(shè)計(jì)，數(shù)據(jù)處理的邏輯，等等這些，如果有詳細(xì)的文檔做支撐，對新成員快速融入非常重要。
本文不是一篇技術(shù)貼，是一篇個(gè)人這一年學(xué)習(xí)的感悟。
作為入行一年的初級PHP程序員，在這一年的學(xué)習(xí)中越來越感覺，不僅僅要寫出高質(zhì)量的代碼，還得寫出好文檔。
高質(zhì)量的代碼真的很重要，閱讀高質(zhì)量的代碼就感覺像是在看高質(zhì)量的漫畫一樣，從變量或方法的命名，到復(fù)雜邏輯的分解，甚至一個(gè)注釋的空格，都不能多一個(gè)或少一個(gè)，記得上個(gè)月寫代碼注釋時(shí)，//符號與注釋間少了個(gè)Space鍵，都是不被允許的。引用Boss的一個(gè)觀點(diǎn)：“程序員有兩種，一種是只為自己寫代碼，而不為別人考慮；一種是為了伙伴寫代碼，盡量不要給別人留坑添麻煩”。完全贊同這種觀點(diǎn)，只有精雕細(xì)琢才能寫出優(yōu)美的代碼，高質(zhì)量的代碼，不給隊(duì)友添麻煩。
同時(shí)，個(gè)人感覺一個(gè)好的文檔也非常非常重要，會(huì)極大提高團(tuán)隊(duì)的效率。很多代碼的邏輯都是業(yè)務(wù)邏輯，如果有一份好的文檔來詳細(xì)解釋一些業(yè)務(wù)的東西，這對新成員是非常有幫助的，如果僅僅看代碼是很難搞清楚代碼邏輯。每一個(gè)Repo都有每一個(gè)Repo的業(yè)務(wù)作用，它的設(shè)計(jì)一定是根據(jù)業(yè)務(wù)邏輯來的，包括表的字段設(shè)計(jì)，數(shù)據(jù)處理的邏輯，等等這些，如果有詳細(xì)的文檔做支撐，對新成員快速融入非常重要。還有包括對Repo的代碼邏輯，和涉及到相關(guān)知識點(diǎn)或工具的解釋，都可以寫在對應(yīng)Repo里的文檔，而且文檔又是可以供大家Git相互協(xié)作完成。代碼和文檔是分不開的，也不能分開才對。
最后，推薦下Atlassian的文檔管理工具Confluence，這是收費(fèi)的Web App，但極大提高效率，所以軟件費(fèi)用算是小錢了。Confluence的功能倒是很強(qiáng)大，實(shí)際上Atlasssian家的軟件從聊天協(xié)作工具HipChat，文檔管理工具Confluence，Continues Integration工具Bamboo，項(xiàng)目管理工具JIRA，Git客戶端管理工具SourceTree，代碼托管平臺(tái)Bitbucket Server，這些工具有收費(fèi)免費(fèi)的，都非常棒，我司也在用，用的也很順手，值得感興趣的關(guān)注下。當(dāng)然這不是廣告，只是覺得不錯(cuò)推薦下。好的生產(chǎn)工具能極大提高生產(chǎn)效率。
這里發(fā)表一個(gè)極端觀點(diǎn)：如果在團(tuán)隊(duì)中還在用QQ等非常棒的社交工具做團(tuán)隊(duì)任務(wù)協(xié)作工具，要么向團(tuán)隊(duì)推薦HipChat或Slack這樣的協(xié)作工具，要么如果建議不被理睬就趕緊走人，別在這種不重視技術(shù)的地方浪費(fèi)時(shí)間了。
做一個(gè)為了伙伴去寫代碼的程序員，寫得了好代碼，也寫得了好文檔。
歡迎關(guān)注Laravel-China。
RightCapital招聘Laravel DevOps
文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/30489.html
摘要：正是前人的努力，我們現(xiàn)在的編程才會(huì)如此的容易。讀懂他人代碼算法如果別人是大牛，數(shù)學(xué)學(xué)得很好，很多數(shù)學(xué)公式，很多遞歸，如果自己沒有一定的數(shù)學(xué)基礎(chǔ)，可能就暈了，這個(gè)時(shí)候，數(shù)學(xué)的基本功可能就會(huì)在這里發(fā)揮作用了。 作者：caoglish原文鏈接：http://t.cn/RKcyGX3來源：知乎 查詢和閱讀文檔能力 原因：你使用編程來解決問題的時(shí)候，基本上最終的東西是代碼，但是編程的知識太廣，總...
摘要：正是前人的努力，我們現(xiàn)在的編程才會(huì)如此的容易。讀懂他人代碼算法如果別人是大牛，數(shù)學(xué)學(xué)得很好，很多數(shù)學(xué)公式，很多遞歸，如果自己沒有一定的數(shù)學(xué)基礎(chǔ)，可能就暈了，這個(gè)時(shí)候，數(shù)學(xué)的基本功可能就會(huì)在這里發(fā)揮作用了。 作者：caoglish原文鏈接：http://t.cn/RKcyGX3來源：知乎 查詢和閱讀文檔能力 原因：你使用編程來解決問題的時(shí)候，基本上最終的東西是代碼，但是編程的知識太廣，總...
摘要：正是前人的努力，我們現(xiàn)在的編程才會(huì)如此的容易。讀懂他人代碼算法如果別人是大牛，數(shù)學(xué)學(xué)得很好，很多數(shù)學(xué)公式，很多遞歸，如果自己沒有一定的數(shù)學(xué)基礎(chǔ)，可能就暈了，這個(gè)時(shí)候，數(shù)學(xué)的基本功可能就會(huì)在這里發(fā)揮作用了。 作者：caoglish原文鏈接：http://t.cn/RKcyGX3來源：知乎 查詢和閱讀文檔能力 原因：你使用編程來解決問題的時(shí)候，基本上最終的東西是代碼，但是編程的知識太廣，總...
閱讀 3526·2023-04-25 17:35
閱讀 2599·2021-11-24 09:39
閱讀 2538·2021-10-18 13:32
閱讀 3424·2021-10-11 10:58
閱讀 1642·2021-09-26 09:55
閱讀 6175·2021-09-22 15:47
閱讀 972·2021-08-26 14:15
閱讀 3476·2019-08-30 15:55
