tft每日頭條

 > 圖文

 > 程序員為什麼要寫文檔

程序員為什麼要寫文檔

圖文 更新时间:2025-02-12 04:05:01

程序員為什麼要寫文檔?今天不想說别的,聊一聊開發文檔,實在不想談論這個話題程序員最讨厭的兩件事情,寫文檔和寫注釋都是一些很繁瑣的事情那麼我們聊一聊為啥要寫文檔,接下來我們就來聊聊關于程序員為什麼要寫文檔?以下内容大家不妨參考一二希望能幫到您!

程序員為什麼要寫文檔(聊聊開發為啥要寫文檔)1

程序員為什麼要寫文檔

今天不想說别的,聊一聊開發文檔,實在不想談論這個話題。程序員最讨厭的兩件事情,寫文檔和寫注釋。都是一些很繁瑣的事情。那麼我們聊一聊為啥要寫文檔。

在這之前我們要知道文檔是用來做什麼的,開發所用的的文檔一般就是功能設計文檔,這個文檔中會寫清楚這個軟件開發過程中,涉及到的所有功能的實現,功能所涉及的數據量是什麼樣的,同意的變量名稱 ,同意的方法,類及接口名稱都是在内部規定好的。

一、是有助于在開發過程中的協作,因為開發是一個團隊的工作,他不是一個人的事情,統一的文檔可以減少很多不必要的交涉,例如調用接口時出錯,後來發現在代碼中定義的名稱不同,導緻無法調用等。

二、如果有新人加入團隊了,可以通過文檔快速的了解項目的構造和開發邏輯。(當然,具體實現還是要看代碼中注釋的)這樣也可以減少很多的人工損耗,畢竟減少了交流就可以有更多的時間來做其他的東西。

其實說白了,寫文檔就是為了說明開發的思路及過程的,讓一個外行人也能一目了然地看懂這個項目的構造和實現是最好的

(最後補一句,我不想寫文檔。。。/(ㄒoㄒ)/~~)

更多精彩资讯请关注tft每日頭條,我们将持续为您更新最新资讯!

查看全部

相关圖文资讯推荐

热门圖文资讯推荐

网友关注

Copyright 2023-2025 - www.tftnews.com All Rights Reserved