@VarshiniPasumamula wrote:
Hello Everyone!
I am implementing LabVIEW Codes for automation testing of a product. Can you help me with the best practice to document the implemented code, if any new engineer wants to understand.
Waiting for your reply 🙂
Are you trying to document the code itself, meaning what a person sees on the block diagram? This is usually what you would do if you make example code with the intent that someone else uses it as a starting point, and then modifies it.
Or is what you really want to document is the use of a set of premade subVIs that they can call? Meaning that most likely the contents of your VI are not likely to be looked at or modified by the user, and it's more likely that they'll just put down the premade subVIs in their own code?
If it's the first one, crossrulz and Andrey have some good feedback to start with, but if it's the second one then there's 3 main things:
1. For each subVI, add as much detail about what it does, including what the inputs and outputs mean, in the "VI Description" field on the Documentation tab in the VI Properties window.
2. Be sure to thoughtfully set the "Required", "Recommended", and "Optional" settings on all inputs to each subVI, so it is clear which inputs must be used and which have usable default inputs.
3. Use good labels for the inputs and output terminals on each subVI. If an input isn't required, put its default value in the input terminal name (in parenthesis). If an input or output is a numeric, specify units (such as Amps or millimeters) in the input or output terminal, so the type and magnitude of the input is easy to figure out.
