論寫文檔的重要性

BlackMass 發布于2019-07-01 12:19 / 657人閱讀

摘要：同時，個人感覺一個好的文檔也非常非常重要，會極大提高團隊的效率。每一個都有每一個的業務作用，它的設計一定是根據業務邏輯來的，包括表的字段設計，數據處理的邏輯，等等這些，如果有詳細的文檔做支撐，對新成員快速融入非常重要。

本文不是一篇技術貼，是一篇個人這一年學習的感悟。

作為入行一年的初級PHP程序員，在這一年的學習中越來越感覺，不僅僅要寫出高質量的代碼，還得寫出好文檔。

高質量的代碼真的很重要，閱讀高質量的代碼就感覺像是在看高質量的漫畫一樣，從變量或方法的命名，到復雜邏輯的分解，甚至一個注釋的空格，都不能多一個或少一個，記得上個月寫代碼注釋時，//符號與注釋間少了個Space鍵，都是不被允許的。引用Boss的一個觀點：“程序員有兩種，一種是只為自己寫代碼，而不為別人考慮；一種是為了伙伴寫代碼，盡量不要給別人留坑添麻煩”。完全贊同這種觀點，只有精雕細琢才能寫出優美的代碼，高質量的代碼，不給隊友添麻煩。

同時，個人感覺一個好的文檔也非常非常重要，會極大提高團隊的效率。很多代碼的邏輯都是業務邏輯，如果有一份好的文檔來詳細解釋一些業務的東西，這對新成員是非常有幫助的，如果僅僅看代碼是很難搞清楚代碼邏輯。每一個Repo都有每一個Repo的業務作用，它的設計一定是根據業務邏輯來的，包括表的字段設計，數據處理的邏輯，等等這些，如果有詳細的文檔做支撐，對新成員快速融入非常重要。還有包括對Repo的代碼邏輯，和涉及到相關知識點或工具的解釋，都可以寫在對應Repo里的文檔，而且文檔又是可以供大家Git相互協作完成。代碼和文檔是分不開的，也不能分開才對。

最后，推薦下Atlassian的文檔管理工具Confluence，這是收費的Web App，但極大提高效率，所以軟件費用算是小錢了。Confluence的功能倒是很強大，實際上Atlasssian家的軟件從聊天協作工具HipChat，文檔管理工具Confluence，Continues Integration工具Bamboo，項目管理工具JIRA，Git客戶端管理工具SourceTree，代碼托管平臺Bitbucket Server，這些工具有收費免費的，都非常棒，我司也在用，用的也很順手，值得感興趣的關注下。當然這不是廣告，只是覺得不錯推薦下。好的生產工具能極大提高生產效率。

這里發表一個極端觀點：如果在團隊中還在用QQ等非常棒的社交工具做團隊任務協作工具，要么向團隊推薦HipChat或Slack這樣的協作工具，要么如果建議不被理睬就趕緊走人，別在這種不重視技術的地方浪費時間了。

做一個為了伙伴去寫代碼的程序員，寫得了好代碼，也寫得了好文檔。

歡迎關注Laravel-China。

RightCapital招聘Laravel DevOps

GPU云服務器云服務器好域名的重要性學算法的重要性數據存儲的重要性人工智能的重要性

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://m.specialneedsforspecialkids.com/yun/30489.html

什么是編程的基本功？

摘要：正是前人的努力，我們現在的編程才會如此的容易。讀懂他人代碼算法如果別人是大牛，數學學得很好，很多數學公式，很多遞歸，如果自己沒有一定的數學基礎，可能就暈了，這個時候，數學的基本功可能就會在這里發揮作用了。作者：caoglish原文鏈接：http://t.cn/RKcyGX3來源：知乎查詢和閱讀文檔能力原因：你使用編程來解決問題的時候，基本上最終的東西是代碼，但是編程的知識太廣，總...

Acceml 2019-08-15 10:48 評論0 收藏0
什么是編程的基本功？

摘要：正是前人的努力，我們現在的編程才會如此的容易。讀懂他人代碼算法如果別人是大牛，數學學得很好，很多數學公式，很多遞歸，如果自己沒有一定的數學基礎，可能就暈了，這個時候，數學的基本功可能就會在這里發揮作用了。作者：caoglish原文鏈接：http://t.cn/RKcyGX3來源：知乎查詢和閱讀文檔能力原因：你使用編程來解決問題的時候，基本上最終的東西是代碼，但是編程的知識太廣，總...

lansheng228 2019-06-27 17:01 評論0 收藏0
什么是編程的基本功？

摘要：正是前人的努力，我們現在的編程才會如此的容易。讀懂他人代碼算法如果別人是大牛，數學學得很好，很多數學公式，很多遞歸，如果自己沒有一定的數學基礎，可能就暈了，這個時候，數學的基本功可能就會在這里發揮作用了。作者：caoglish原文鏈接：http://t.cn/RKcyGX3來源：知乎查詢和閱讀文檔能力原因：你使用編程來解決問題的時候，基本上最終的東西是代碼，但是編程的知識太廣，總...

bbbbbb 2019-08-29 12:56 評論0 收藏0