LabVIEW新手的5大錯誤
加入技術交流群
不重視文檔記錄
優秀的代碼文檔可以有效地幫助他人理解自己寫的程序。遺憾的是，許多程序員通常在開發周期末期功能開發結束之后才開始進行文檔撰寫。這使得用于對代碼進行文檔記錄的時間變得非常少。正確的做法應該是在開發過程中就需抽出時間來開始進行文檔記錄。文檔對于編程人員自身也非常有用，尤其是當他們過段時間回來看代碼卻不記得當初他們為什么選擇某些代碼時。程序員經常會一邊喝著咖啡，一邊熬夜編程，這往往會出現“短暫失憶”。而文檔則可以幫助程序員進行回憶。
一般情況下，相對于基于文本的程序，LabVIEW的圖形化特性使得程序閱讀更為容易，但是有效的文檔記錄可以減少“解碼”程序所需的時間。添加文檔注釋到程序框圖的最簡單方式是使用自由標簽。您可以在框圖的空白位置雙擊左鍵，并輸入文字，添加注釋。然后，使用箭頭標記來指向自由標簽引用的特定代碼。如果需要添加圖片，則可將它們復制到剪貼板，然后粘貼到程序框圖中。物理系統圖片和數學公式均有助于清晰說明程序框圖內的代碼上下文。
圖 6.架構正確且文檔記錄充分的代碼不僅可幫助其他人理解您的代碼，也可幫助您更好地理解自己的代碼
對代碼進行文檔記錄不僅只是針對復用程序庫，而應該是針對每一個程序。當一個人需要為其他人講解時，他對該主題將會有更深刻的理解。文檔記錄從本質上看就是在迫使程序員進行講解，以幫助他們更好地了解自己的代碼。
評論