為什么學(xué)習(xí)嵌入式時(shí)就要寫(xiě)文檔？

來(lái)源：培訓(xùn)無(wú)憂網(wǎng) 發(fā)布人：星星

2022-01-18 11:51:20|已瀏覽：5102次

學(xué)習(xí)嵌入式時(shí)就要寫(xiě)文檔

很多程序員工作中非常輕視文檔的書(shū)寫(xiě)，但又時(shí)常抱怨別人不寫(xiě)文檔，或者說(shuō)文檔質(zhì)量不好，不夠完善，更別說(shuō)一些剛學(xué)習(xí)嵌入式的新手了。

為什么大家都不愿意寫(xiě)文檔，因?yàn)槲臋n有著滯后性，不能立刻體現(xiàn)出它的價(jià)值。所以很多人更喜歡跑測(cè)試，一跑就知道有沒(méi)有問(wèn)題了，這樣的價(jià)值體現(xiàn)就會(huì)快許多。而且文檔的價(jià)值更多的不是在開(kāi)發(fā)者手中體現(xiàn)的，而是在其他人閱讀的過(guò)程中體現(xiàn)的。
其實(shí)很多人是會(huì)把代碼和文檔割裂開(kāi)來(lái)，在思想層面上二者就是分開(kāi)的，所以很多人不會(huì)將二者同時(shí)進(jìn)行。其次有些人寫(xiě)文檔本來(lái)就不怎么好，干脆就不寫(xiě)了，有時(shí)候更是懶惰作祟。更別說(shuō)寫(xiě)文檔其實(shí)是增加工作負(fù)擔(dān)，自己的工作都沒(méi)空處理，哪還有空去寫(xiě)文檔。
即便寫(xiě)文檔有這么多壞處，其好處也不少。比如說(shuō)可以幫你審視你的API，讓其更加規(guī)范化，這個(gè)過(guò)程其實(shí)就是檢驗(yàn)的過(guò)程，讓你可以從頭檢查一次自己的代碼。而這樣的文檔一般在你回頭看的時(shí)候可以快速知道自己寫(xiě)了什么，別人也更清晰地了解你的代碼。
當(dāng)別人問(wèn)你問(wèn)題的時(shí)候，你也可以直接丟文檔讓他自己看，雖然寫(xiě)文檔需要時(shí)間，但也減少了解答問(wèn)題的時(shí)間。這樣還能讓別人覺(jué)得你的代碼非常專(zhuān)業(yè)，畢竟同樣的時(shí)間，質(zhì)量下，你做了更多的東西。所以，建議大家在學(xué)習(xí)嵌入式的時(shí)候就要養(yǎng)成好習(xí)慣。早期養(yǎng)成良好習(xí)慣就不用擔(dān)心工作的時(shí)候沒(méi)有時(shí)間去重新掌握，而且當(dāng)你熟悉了書(shū)寫(xiě)步驟其實(shí)會(huì)進(jìn)一步提高你的工作效率。

注：尊重原創(chuàng)文章,轉(zhuǎn)載請(qǐng)注明出處和鏈接 http://elsolbar.com/news-id-15973.html 違者必究！部分文章來(lái)源于網(wǎng)絡(luò)由培訓(xùn)無(wú)憂網(wǎng)編輯部人員整理發(fā)布,內(nèi)容真實(shí)性請(qǐng)自行核實(shí)或聯(lián)系我們，了解更多相關(guān)資訊請(qǐng)關(guān)注嵌入式開(kāi)發(fā)頻道查看更多，了解相關(guān)專(zhuān)業(yè)課程信息您可在線咨詢(xún)也可免費(fèi)申請(qǐng)?jiān)囌n。關(guān)注官方微信了解更多：150 3333 6050

相關(guān)新聞

相關(guān)新聞

免費(fèi) 申請(qǐng) 試聽(tīng)

提交申請(qǐng)，《培訓(xùn)無(wú)憂網(wǎng)》課程顧問(wèn)老師會(huì)一對(duì)一幫助你規(guī)劃更適合你的專(zhuān)業(yè)課程！