新聞中心

LabVIEW新手5大錯(cuò)誤

作者: 時(shí)間:2013-09-06 來(lái)源:電子產(chǎn)品世界 收藏

  不重視文檔記錄

本文引用地址:http://butianyuan.cn/article/167320.htm

  優(yōu)秀的代碼文檔可以有效地幫助他人理解自己寫的程序。遺憾的是,許多程序員通常在開發(fā)周期末期功能開發(fā)結(jié)束之后才開始進(jìn)行文檔撰寫。這使得用于對(duì)代碼進(jìn)行文檔記錄的時(shí)間變得非常少。正確的做法應(yīng)該是在開發(fā)過(guò)程中就需抽出時(shí)間來(lái)開始進(jìn)行文檔記錄。文檔對(duì)于編程人員自身也非常有用,尤其是當(dāng)他們過(guò)段時(shí)間回來(lái)看代碼卻不記得當(dāng)初他們?yōu)槭裁催x擇某些代碼時(shí)。程序員經(jīng)常會(huì)一邊喝著咖啡,一邊熬夜編程,這往往會(huì)出現(xiàn)“短暫失憶”。而文檔則可以幫助程序員進(jìn)行回憶。

  一般情況下,相對(duì)于基于文本的程序,的圖形化特性使得程序閱讀更為容易,但是有效的文檔記錄可以減少“解碼”程序所需的時(shí)間。添加文檔注釋到的最簡(jiǎn)單方式是使用自由標(biāo)簽。您可以在框圖的空白位置雙擊左鍵,并輸入文字,添加注釋。然后,使用箭頭標(biāo)記來(lái)指向自由標(biāo)簽引用的特定代碼。如果需要添加圖片,則可將它們復(fù)制到剪貼板,然后粘貼到中。物理系統(tǒng)圖片和數(shù)學(xué)公式均有助于清晰說(shuō)明內(nèi)的代碼上下文。

  對(duì)代碼進(jìn)行文檔記錄不僅只是針對(duì)復(fù)用程序庫(kù),而應(yīng)該是針對(duì)每一個(gè)程序。當(dāng)一個(gè)人需要為其他人講解時(shí),他對(duì)該主題將會(huì)有更深刻的理解。文檔記錄從本質(zhì)上看就是在迫使程序員進(jìn)行講解,以幫助他們更好地了解自己的代碼。

  旨在幫助工程師和科學(xué)家更成功地應(yīng)對(duì)全球最嚴(yán)峻的挑戰(zhàn)。社區(qū)擁有龐大的工程師和科學(xué)家會(huì)員,為其提供了一個(gè)有效的平臺(tái)來(lái)與他人分享知識(shí)。


上一頁(yè) 1 2 3 下一頁(yè)

評(píng)論


相關(guān)推薦

技術(shù)專區(qū)

關(guān)閉