LabVIEW編程規范 IntelligentElectronicsInstituteHuazhongUniversityofScience Technology 2 目錄 編程規范的重要性前面板創建規范背面板創建規范VI圖標和連接器創建規范 3 編程規范的重要性 編程規范是指某種計算機編程語言的基本風格或典范模式 或者說是將計算機要執行的任務 按某種編程語言的基本風格或典范模式 形成概念化和結構化設計框架與實現方式 4 編程規范的重要性 軟件是一個復雜的體系好的軟件程序應當具備以下特性 易用性 高效性 可讀性可維護性 健壯性 簡潔性 5 編程規范的重要性 對一個給定的具體軟件任務 也許有多種實現方式去完成同一功能 個人的偏好 編程的風格 軟件的需求對程序開發有著重要的影響 并且開發人員的意向直接影響程序應用的實際效果 軟件程序要達到以上的諸多特性 開發團隊人員之間必須要有一種通用的規定約束 以盡量減少個人的主觀隨意性色彩 6 編程規范的重要性 LabVIEW提供多種方式來創造程序的樣式 而且在實際開發應用中也可看到許多不同的編程規范 好的規范可以開發出更優秀的程序 兼顧編程規范與軟件開發時間的平衡選取 7 編程規范的重要性 形成良好編程規范習慣 需要進行前期準備工作 主要包括以下4個方面 寫需求說明 構建軟件設計架構 配置LabVIEW環境 制定項目工程管理規范 8 前面板創建規范 布局 配色 幫助信息 9 前面板創建規范 布局 一個項目所需的設計主要包括用戶界面設計 程序結構設計 接口設計 模塊設計等 對于編寫LabVIEW程序 通常先做用戶界面設計 可以使界面不受程序實現的影響 先設計程序結構 再設計界面 難免會朝著簡化編碼工作方向去努力 但是這樣的界面設計往往不是最方便用戶使用的狀態 10 前面板創建規范 布局 對于界面設計的評價首先 看這個界面是否完成了其交互功能 用戶可以通過界面為程序提供必要的信息 可以通過界面接收到需要的信息 其次 通過這個界面用戶可以簡單直觀地輸入或獲取信息 最后 才是界面的美觀程度 11 前面板創建規范 布局 好的用戶界面都有一些共同的特點 使用恰當的數據類型和控件類型控件的分類排布合理 簡潔顏色搭配科學有必要的文檔說明和注釋 12 前面板創建規范 布局 關于布局的幾條基本原則 最重要控件放在最醒目位置對于布局 就是將最重要部分放在最顯眼的地方 這是一個非常重要的規范 根據大多數人的閱讀習慣 總是從左到右 從上到下 因此要把最重要的部分放在左上角 LabVIEW提供了排列控件 控件對齊 等間隔這些工具 通過這些工具 程序設計人員就可以非常方便地布置界面上的控件 13 前面板創建規范 布局 同一類控件進行歸類和相似控件的尺寸保持一致除了使用布局工具將控件對稱排列整齊 編程人員還需要將同一類控件進行歸類 并且相似控件的尺寸最好保持一致 這樣就可使界面看上去更加有層次感 LabVIEW編程提供了可通過多種裝飾控件 空白間隔 選項卡和簇來對控件進行歸類的方法 使不同控件看上去有豐富的層次感 14 前面板創建規范 布局 正確調控窗口大小進行窗口大小調控是非常重要的 一般而言 程序員在一個分辨率的顯示器下開發的程序 如果在另外一個不同分辨率的顯示器上運行時 就有可能使界面兩端的空白區域顯示出來 為了解決這個問題 LabVIEW編程軟件在 VI屬性 菜單欄的窗口大小中有兩個選項 第一個選項可以讓程序在不同分辨率下保持窗口比例 第二個選項可以根據窗口的尺寸 自動調節界面中控件的大小 15 前面板創建規范 布局 圖示是我們智能電子學研究所 IEI 完成的程序開發項目 對于程序設計人員來說 版權是最重要的 所以我們將研究所的圖徽放在了左上角 整個界面雖然控件很多 但是排列整齊 而且對功能類似的控件進行了有效的分類 讓人一看上去就清晰 明了 16 前面板創建規范 布局 圖形用戶界面 GUI GUI 即圖形用戶界面 是指采用圖形方式顯示的用戶操作界面 GUI分為桌面GUI和工業GUI 桌面GUI 主要提供給個人在辦公室 私人實驗室或其他個人計算環境下使用 工業GUI 使用場合是與儀器設備相關 實現工業測試測量 嵌入式控制 設計典型應用環境 17 前面板創建規范 布局 關于GUI的幾點布局規范 工業GUIVI中主VI面板顯示最大化工業GUI常作為監視和控制工業設備的專門接口 不希望提供可視的操作系統接入 以避免用戶訪問與應用無關的資源 因此 對于工業GUIVI 應該將主VI面板最大化 大多數工業GUIVI都會隨PC啟動而自動運行 并且主VI面板會占據整個屏幕 該功能是通過設置 窗口運行時最大化 屬性來實現的 可通過 文件 VI屬性 選取 然后從 類別 中選擇 窗口運行時位置 在位置選項中選擇 最大化 18 前面板創建規范 布局 正確設置GUIVI分辨率在某一個分辨率下開發的程序 在另一個分辨率下運行時 如果顯示分辨率增加 前面板的一些附加部分會顯示出來 這就有可能暴露了在開發過程中需要對用戶隱藏的控件部分 因此 如果不想讓用戶看見這些控件 就要保證控件對用戶是不可見的 19 前面板創建規范 布局 GUIVI面板中對話框設置和使用對話框VI前面板的顯示應該居中并且小于全屏尺寸 這樣既可以讓用戶很容易識別出它們是對話框 還可以在面板打開時總出現在屏幕的中央 一般可以通過VI屬性中 窗口運行時位置 中設置屬性為窗口中心來實現 與此同時 對話框VI也必須注意分辨率的設置問題 而且還應考慮幾個對話框同步打開時的情況 20 前面板創建規范 布局 工業GUI自定義對話框VILabVIEW用戶可以根據具體需求自定義對話框 自定義對話框VI對桌面GUI和工業GUI都是適用的 對于桌面GUI而言 從 文件 VI屬性 窗口外觀 中設置對話框的窗口外觀屬性 面板背景顏色 模式行為及其他屬性 選擇一個與操作系統對話框類似的對話框 盡量保持與操作系統對話框的一致 對于工業GUI 需要較大的面板 控件和文本 3D風格的控件會經常用在工業GUI的界面設計中 并且還要根據重要性來調節工業GUI的大小和位置 21 前面板創建規范 布局 桌面GUI和工業GUI的區別示例 22 前面板創建規范 布局 關于GUIVI還有幾點值得提醒 在滿足應用需求前提下 界面盡可能簡潔 不要重疊控件 也不能因為控件多而出現界面重疊的現象 適度隱藏開發界面上所有調試按鈕工具欄 特別是為程序添加一個停止按鈕 不要使用開發界面提供的中止運行按鈕 可以用一個停止控件來退出需要關閉的程序 給完成的GUI設計放上一個圖標 23 前面板創建規范 布局 子VI 對于子VI面板上的控件 文本基本上采用默認的外觀 簡單明了 方便判斷其是否為子VI即可 24 前面板創建規范 配色 關于顏色的搭配 有幾個重要的原則 總體協調 局部對比設計一個LabVIEW前面板 其整體的色調應該是協調的 而局部或者小范圍內 可以使用一些亮色來形成對比 經常看到一些GUI的配色讓人感到不舒服 其存在的一個共同問題是顏色太多 所以 程序開發人員要謹慎地使用顏色 界面的配色就像穿衣時的顏色搭配一樣 總體上不要超過3種 否則會給人一種眼花繚亂的視覺 25 前面板創建規范 配色 相關控件采用同一種顏色 同一個應用程序的所有VI界面 可采用一致的配色方案 一般子VI的面板和控件不需要配色前面提到要對相關的控件進行歸類 突出層次感 對控件顏色的使用也是很好的歸類方式之一 同一個應用程序中應該保持一致的顏色主題 對于子VI的前面板就不需要顏色了 只需保持默認的外觀 有助于將其識別為子VI即可 26 前面板創建規范 配色 遵循通用的慣例我們經常使用的一些亮色 比如紅色 黃色 綠色 在使用中盡量遵循工業標準的一些規范 比如說紅色表示警告 用來表示一些非常緊急的情況 黃色用來引起注意 綠色表示整個工作是非常正常的狀態 27 前面板創建規范 配色 黑 白色是經典配色黑 白色是不會過時最經典的顏色 當打開一個VI的前面板 不知道如何下手設計時 首先可以將前面板的背景設置為全黑或者全白 然后根據個人的創意搭配一些局部的小的亮色 同樣也能設計出美觀的界面 28 前面板創建規范 配色 最重要的是對界面顏色的設計 必須建立在保證應用程序功能正確的基礎上大多數LabVIEW應用程序基本目的是測試 測量和控制 在關鍵的應用需求得到滿足后 若時間允許 才會考慮配色方案的設計 29 前面板創建規范 幫助信息 幫助信息主要是指為了幫助新手而提供的一些說明文檔 任何描述結構 組件 系統操作 應用程序及源代碼的文件都稱為說明文檔 說明文檔的具體內容因應用類型 開發人員 用戶的不同而相異 前面板的說明文檔一般包括控件標簽 描述 提示條和自由標簽 30 前面板創建規范 幫助信息 說明文檔的通用規范 盡量減少在前面板中使用說明文檔直觀的前面板一般是圖形化設計的 而不是文本式描述的 因而 無論是用戶還是程序開發者 都不想在前面板看到太多的文本式描述 相比之下 通俗易懂的按鈕 控件 圖標和圖片 則會更受歡迎 因此 應該避免在標簽和控件中加入太多的文本 31 前面板創建規范 幫助信息 創建直觀 明了的GUI來減少文本的使用在創建GUI時 對于不可避免的文檔說明 盡量使用Help菜單或標簽為Help的按鈕 還可以根據要求從LabVIEW載入幫助信息 如在線文檔 LabVIEWContextHelp窗口 在外部文檔或編寫的幫助文件內創建用戶手冊或幫助標題 32 前面板創建規范 幫助信息 特別提醒對于一個大項目的開發 往往是一個團隊的工作 團隊每位開發人員可能會在自己的任務VI中為同事留下注釋文本 幫助理解和閱讀程序 對于這些文本 在整個開發任務結束時 是應該刪掉的 33 前面板創建規范 幫助信息 說明文檔撰寫應該注意的事項 對于同一個應用程序 應該采用一致的字體 可以通過改變尺寸 粗細和顏色來達到多種文本樣式通常 應用程序需要多種類型文本來區分不同類型的數據和事件 比如 通常在工業GUI內 會用大號粗體來顯示重要數據或者標題 對那些報警 警告之類的重要信息 則會采用強對比的顏色 此時應該注意到 太多的文本類型會使整個界面顯得雜亂 34 前面板創建規范 幫助信息 同一個應用程序 不同的文本樣式最好不要超過3種 否則界面就會變得難以分辨且分散用戶的注意力前面講到關于控件的歸類 對類似的控件 標簽盡量使用一致的文本樣式 這樣既有層次感 又減少了文本樣式的使用 選擇一致的文本樣式既可以節省開發時間 又能提高程序的易用性 35 前面板創建規范 幫助信息 使用簡潔 直觀的控件標簽在LabVIEW的應用程序中 有一種看起來最醒目的文本類型 即控件標簽 使用簡潔 直觀的控件標簽對程序的易用性是很重要的 另外 盡量為每個代表物理參數的控件附加上默認值和單位 當需要使用很長的描述或者GUI標簽的設計與控件標簽不同時 盡量使用標題 如果通過標簽還不能將對象的性質表述清楚 那就需要輸入一兩行的描述性文本 也可以是具有描述性短語的提示條 當鼠標光標放在控件上時 提示條就會顯示簡略的描述 36 前面板創建規范 幫助信息 子VI的說明文檔采用默認值為宜子VI的說明文檔一般使用默認值即可 除了商用子VI 如儀器驅動和開發工具箱 其所有的控件和指示器應該是粗體的 而在附加的默認值和單位則是普通文本 而工業GUI 根據其應用場合 一般需要采用較大的文本來顯示命令按鈕和重要數據 文本的顏色也應該和背景色有很高的對比度 對于多平臺應用程序 需要在標簽和對象之間留下額外的空間 37 背面板創建規范 布局 連線 數據流 程序注釋 38 背面板創建規范 布局 背面板上顯示的是程序框圖 雖然不像前面板的控件那樣直接與用戶交互 但是良好的背面板布局 對于程序的可讀性是很重要的 LabVIEW作為圖形化系統設計編程語言 應當考慮將源代碼控制在一屏能顯示的范圍內 39 背面板創建規范 布局 在背面板布局時 應當遵循以下一些規范 不要給程序框圖著色界面的背景色和每個結構的子界面都默認為白色 數據流向非常容易識別 對象盡量布局緊湊 但同時對象不能靠得太近從而引起對象和連線重疊 盡量縮小程序框圖大小使之能在一個屏幕顯示出來 在某些情況下 比如說某些復雜的程序包含很多個并行循環 要滿足這個限定非常困難 在這種情況下 調整程序框圖 或者將一些循環變成子VI來減小所占的背面板空間 使背面板僅在一個方向上滑動 40 背面板創建規范 布局 采用從上至下和自下而上相結合的方法 來構建多層次結構關系VIVI的層次結構可以通過選擇 查看 VI層次結構 來查看 窗口的工具條包括VILib 全局變量和自定義類型 只顯示自己提供的用戶VI 通常的幾何形狀包括直線型和圓角型 除了非常簡單的應用程序外 VI層次結構中在頂層VI之下應包含多行子VI 41 背面板創建規范 布局 應用程序可采用大量的數值屬性節點來控制GUI行為許多屬性節點的讀 寫操作都是由GUI事件觸發的 因此 事件結構是理想的處理屬性節點結構 因為事件結構為每個事件分支分配一個單獨的子程序 一個事件分支的程序不會跑到其他事件分支 然而 多事件分支需要許多個相同的屬性節點 其值因每次讀 寫操作而不同 將這些普通的屬性節點模塊化為子VI 通過控件引用和屬性值傳遞到子VI中 每個子VI程序代表在內存中同一屬性節點的備份 這減小了內存使用和程序復雜性 42 背面板創建規范 布局 創建可見子VI可為程序開發節省背面板空間子VI非常有用 因為相對于一個大型程序來說 它易于開發 測試 調試 維護和代碼重用 因而 子VI也為程序開發中節省了可觀的背面板空間 總之 如果同一函數 屬性節點 程序被多次調用 將這些重復代碼換成子VI將使程序開發變得簡單 43 背面板創建規范 布局 記住為每個子VI創建一個有含義的圖標和相應的描述圖標和描述信息能幫助在調用這些子VI的程序時 可通過幫助窗口的文字識別這些子VI 這些描述可以促使程序設計人員進行內聚性測試 如果程序設計人員不能通過兩到三句話總結子VI的功能 那么子VI可能包含了太多的子代碼 44 背面板創建規范 連線 在布線規則上 LabVIEW編程人員應該遵循一些基本原則 主要包括 盡量使程序中彎折線最少 不要形成扭結和圈保持并行連線之間的間隔不要遮擋連線和節點 避免重疊程序框中的對象 45 背面板創建規范 連線 LabVIEW編程中有自動和手動布線兩種方式來連線和清除連線自動方式優先考慮水平接線端 并且以多余的曲線為代價來避免對象重疊 為了使彎折線最少 必須采用手動方式進行程序連線 此外 在現有的連線上 右擊選擇 整理連線 會自動減少扭結 圈和彎折線 46 背面板創建規范 連線 隧道連線通過結構左側邊界進入結構 并從結構的右側邊界穿過結構不要讓隧道在結構的頂部或底部穿過 同樣如果結構內部未使用到也不要讓連線穿過結構 47 背面板創建規范 連線 避免在程序框圖中重疊連線和節點將偶爾交叉的連線改為橫向和縱向 有時能很好地解決這些問題 例如 通常位于循環結構的左下腳的周期端子 必須連接到右上方的位置 而許多其他的數據流連線 需要經由隧道或移位寄存器在水平方向穿過整個結構 如錯誤簇就是一個典型例子 此外 不要將連線和一個對象或節點重疊 因為連線在函數或子VI下面流動會被誤認為是節點的輸入和輸出 從而影響程序可讀性 48 背面板創建規范 連線 切勿使用局部變量或全局變量來作為一種減少連線的方法變量增加處理開銷 內存使用和程序的復雜性 此外 使用變量破壞了LabVIEW數據流原則 掩蓋了實際的數據來源 當變量從程序的多個位置讀 寫時 就難以確定哪個在實際影響數據值 當使用連線時 很容易追蹤到數據唯一的源終端 49 背面板創建規范 連線 將沒有連線的前面板控件在程序框圖上放在一起 程序開發人員就能非常容易找到布爾控件設置為觸發動作后 控件自身不能自動重置 如果接線端的控件與事件結構中的注冊事件相關 將控件的接線端放在事件結構中 這能保證接線端的值 能夠在事件每次發生時被程序正確讀取 對于那些與事件結構無關的而且沒有連線的接線端 只需將其簡單地放置在程序框圖主結構的左邊 50 背面板創建規范 連線 使用簇來組織相關數據 減少連線的數量若能夠減少面板中的連線 程序的可讀性將得到很大的提高 所以 通常使用簇來組織相關數據 減少連線的數量 在框圖的任何一個地方 如果涉及許多相互關聯的數據 可以用簇來將其替換掉 并且這樣做能方便地將數據傳遞到子VI中 但要特別提醒 簇中的元素必須是相關的 或是有相同的目的地 51 背面板創建規范 數據流 數據流編程是LabVIEW區別于其他文本編程語言的顯著特征之一 所謂數據流 指在LabVIEW中 數據沿著連線 從源端流向終端 程序框圖中 一個節點只有在其所有的輸入端都接收到數據后才會執行 執行完畢后 數據再接著從其輸出端沿著數據流方向流向下一個節點 52 背面板創建規范 數據流 數據流編程應該遵循以下一些基本原則 數據流總是從左流到右除采用反饋節點和順序局部變量編程外 LabVIEW數據流都是沿著連線從左端流向右端的 反饋節點和順序局部變量均是LabVIEW中自帶的結構 但有違背數據流流向的原則 然而正確使用反饋節點 相比移位寄存器來說 是能夠降低混亂連線的 順序局部變量只與層疊順序結構相關 在LabVIEW編程中應該盡量避免使用 53 背面板創建規范 數據流 避免出現數據類型強制轉換為避免在數據傳輸過程中數據類型的不匹配 可以選擇在節點的端子上右擊直接創建輸入控件 顯示控件或常量 通過右擊需要創建控件的節點連線端 在菜單中選擇 創建 常量 輸入控件 顯示控件 與連線段數據類型相符的常量 輸入控件或顯示控件就創建完成了 54 背面板創建規范 數據流 除非必須 盡量避免使用順序結構 特別是能夠并行執行的函數 不要使用順序結構去替換它將程序編寫為能夠獨立并行的函數 能夠有效提高程序的運行效率 55 背面板創建規范 數據流 避免使用超過3層的嵌套結構嵌套結構就是放置在結構體中的結構體 超過兩層或三層的嵌套結構會掩蓋底層的邏輯和數據流信息 一般來講 過多使用嵌套結構 過度使用順序結構是一種有失規范的設計模式 最大化地使用數據流方式和最小化地使用順序結構 能夠有效地避免過多的嵌套 提高程序可讀性 降低錯誤發生的概率 56 背面板創建規范 程序注釋 程序注釋其實也是一種說明文檔 只不過是對背面板源代碼的說明 程序的注釋文檔與源代碼的可讀性 可維護性和可用性直接相關 是非常重要的 LabVIEW的源代碼是圖形化的 本身就沒有漢字 而文檔增加了圖形源代碼的可讀性 57 背面板創建規范 程序注釋 圖示是一個不帶任何說明文檔的程序 其主要功能是對測量儀器進行配置 示例中沒有任何的標簽或注釋 對數據的信息比較少 整個程序的可讀性很差 維護起來也很不方便 58 背面板創建規范 程序注釋 針對上圖進行了改進后 首先 各個控件的標簽進行可見的設置 其次 移位寄存器左端連線進行了標注 并且每個條件結構中也進行了注釋 修改后的程序框圖相比之前清晰了很多 可以很容易看出每個控件的意義和每個條件結構實現的功能 59 背面板創建規范 程序注釋 再進一步完善 主要包括直觀的標簽 枚舉條件結構 使用按名稱捆綁 程序中采用定義儀器名稱的枚舉型變量替換掉 儀器類型 數值型變量 因此 儀器名稱也出現在了條件結構的選擇區域里 由于使用了枚舉型和條件結構 節省了大量結構中的注釋 儀器的信息可以從條件選擇區域中直觀考察 60 VI圖標和連接器創建規范 圖標 連接器 61 VI圖標和連接器創建規范 圖標 圖標是LabVIEW源代碼中的重要特點之一 主要包含各種圖形和文本的組合顯示 用于子VI的識別 提高其可讀性 有助于對主程序框圖說明 一個成功的圖標是對一個VI直觀的描述 一個圖標就能代表一個函數 一個程序 在LabVIEW中 圖標是通過圖標編輯器工具畫出來的 或者是現有的圖片文件 或者是應用程序中復制出來的 62 VI圖標和連接器創建規范 圖標 關于圖標創建的一些規范 制作通俗 易懂 有特定意義圖標由于LabVIEW中圖標都是32 32像素的 所以 圖標里的內容必須小而精煉 要在有限的空間內 制作出清晰易讀且有意義的圖片和字體 正如日常生活中見到的一些符號 如公共標志或是交通信號等 都是圖形和文字結合得很好的例子 LabVIEW圖標制作時也應該具有通俗 易懂 有特定意義 63 VI圖標和連接器創建規范 圖標 在圖標內容小且精煉的前提下 圖標中的文本就必須統一字體格式要求一般對于大多數的文本推薦使用8磅或10磅的字體 LabVIEW中應用程序默認的字體是13磅 如果使用默認字體 那么圖標中每行就只能寫5個字母 這就占了圖標高度的1 3 這種字體只適用于包含少量大寫字母的圖標 而將所有的文本設為8磅或10磅的小字體 將會使圖標上的文本在大小合適 清晰可辨的前提下數量最大化 假如使用8磅小字體的大寫字母 就能在每行寫入7個字母 而且只會占用圖標高度的1 4 64 VI圖標和連接器創建規范 圖標 好圖標應該是圖片 顏色和文本合成的整體符號為了描述更多的內容 用4行文本將圖標填滿 也是不可取的方式 因此 推薦使用8磅或10磅小字體 因為在使用相同文本的前提下 將為圖片和空白區域提供更多的空間 幾種不同圖標字體大寫字母效果的對比 65 VI圖標和連接器創建規范 圖標 關于圖標設計與開發時間的平衡問題總原則是 對于重用率很高的VI 如產品的開發工具包或儀器的驅動 就值得投入大量的時間和精力去設計一個構思精妙的圖標 如果要在短期內開發大量的VI 并且這些VI沒有重復使用的可能 那就無須花大量的精力在圖標的設計上 而是可以用快捷有效的方法設計出一個有特定含義的圖標即可 66 VI圖標和連接器創建規范 圖標 創造一個包含文本 彩色背景