cpu,
I try to include the following info in every VI/subvi:
1. General: (VI name, Version #, Date coded, Author).
2. Description: (paragraph that summarizes its overall functionality).
3. Specifics: (detailed sub paragraphs that specify unique or complex code).
4. Misc: (data type input/outputs, unique conditions for the vi to work, limitations, etc.).
Now, the way I input this info is 3 steps:
1. On the block diagram, I use yellow text boxes to label overall code phases or code subset names (e.g. Initiation phase, run phase, terminal phase, etc.), and light-blue text boxes representing the specific details (what the code is doing). I put these boxes right next to the code its pointing to. The colors just let it show easily.
2. After making s
ure those comments are good, I copy them onto the VI's documentation property field.
3. I also have a separate document (Word, etc.) that provides general overview of the entire project and refers to the VI's printed documentation for details on each VI (which is already documented).
This is how I do it (in an nutshell). It takes extra time, but always worth it. Also, there are topics relating for coding standards, etc., that will provide more ideas.
The main thing with documenting your code is to be sure you do it - one way or another. How you do it should also be consistent across all projects and their VIs.
Doug