Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

Documenting VIs

LabVIEW 8.2 Help
August 2006

NI Part Number:
371361B-01

»View Product Info

You can use LabVIEW to document a finished VI and create instructions for users of VIs. You can view documentation within LabVIEW, print it, and save it to HTML, RTF, or text files.

To create effective documentation for VIs, create VI and object descriptions.

Create descriptions for VIs and their objects, such as controls and indicators, to describe the purpose of the VI or object and to give users instructions for using the VI or object. You can view the descriptions in LabVIEW, print them, or save them to HTML, RTF, or text files.

Create, edit, and view VI descriptions by selecting File»VI Properties and selecting Documentation from the Category pull-down menu. Create, edit, and view object descriptions by right-clicking the object and selecting Description and Tip from the shortcut menu. Tip strips are brief descriptions that appear when you move the cursor over an object while a VI runs. If you do not enter a tip in the Description and Tip dialog box, no tip strip appears. The VI or object description appears in the Context Help window when you move the cursor over the VI icon or object, respectively.

Note   You cannot enter a description for a VI or function located on the Functions palette.

Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit