The Style Guidelines can be used as guidance for how to write an Example Program. These guidelines are broken into two sections, guidelines for the information provided in the Example Program document, and guidelines for the attached or linked code.
Below you can find the fields to be completed when creating an Example Program in the NI Community and a brief description of each field.
These guidelines were created to promote consistency, understanding, and good coding practices for LabVIEW Examples submitted to the NI Community. What follows is a small subset of the guidelines that are used internally for the shipping examples across the LabVIEW platform. The items in blue are tested in the Community Example VI Analyzer tests.
Example code should be clean, easy to read, and well commented. Examples should also be as minimal as possible, only requiring driver software and hardware if the example cannot be written without it. For example, if the main purpose of your example is to illustrate analyzing data after it has been acquired, consider using a constant or file-based sample instead of actually requiring the user to have certain hardware and drivers to supply data for your example.
Icon and Connector Pane
The VI Analyzer test suite only covers a few of the Style Guidelines requirements so we added a few optional tests to help you find other issues that you might want to fix. The spell check is pretty useful! Please refer to the attached instructions and download the zip file when you're ready to get started.