You can use the VI Analyzer Toolkit to review APIs prior to submission for the LabVIEW Tools Network review process. These tests can identify issues with documentation, style, and performance to ensure your LabVIEW code is at the quality level customers expect to find in products listed on the Tools Network. This document contains a tutorial demonstrating how you can use VI Analyzer tests as part of your product review.
The test configuration included with the tutorial below is used to automate identification of the following list of LabVIEW Tools Network Style Requirements along with other performance and documentation checks. For example, VI Analyzer can check for the use of case structures to handle errors passed through VIs and even perform a spell check of comments and documentation.
LabVIEW Tools Network Style Requirements
|A consistent font is used throughout all VIs|
|VIs use path controls instead of string controls for specifying locations of files and folders|
|Controls and indicators do not overlap on the front panels|
|Data flows from left to right|
|All functions, terminals, and constants are aligned and distributed on the block diagram|
|Objects are not placed on top of wires|
|API VIs use consistent (4x2x2x4 or 5x3x3x5) connector pane patterns|
|Common or consistent terminals, such as for references or classes, are used across all API VIs|
|Error wire terminals are always at the bottom left and bottom right|
|All VIs contain a VI description for the Context Help Window|
|Comments are used in all VI block diagrams to document code|
The attached Compatible_with_LabVIEW-Example.cfg file is a sample test configuration for the 'Agilent 34401' API shipped with LabVIEW and found under \instr.lib\Agilent 34401\. You can use this configuration as a starting point for reviewing your APIs.
We strongly encourage you to incorporate VI Analyzer testing into your prerelease review process to ensure code is at a high level of quality prior to sending your product or update to the LabVIEW Tools Network team.