What are some good tips and advice for effective commenting on a VI?

[billko]

---

@BertMcMahan wrote:

---

@billko wrote:

You might not think of wires as being documentation, but if, like others have said, your wires are neat and well-organized, it will be easy to follow them and you won't have guess where they are coming from/going to.

---

Neat wires is the LabVIEW equivalent of neat whitespacing in text-based languages. Imagine if you got someones code that had literally no indents, or even just random indents... how hard would that be to read, even if it functioned? (not Python, of course) You'd need to fix whitespace before you could begin to work on the code.

That's how it is with messy wires in LabVIEW.

     if val>13

val = 2;

else if val>100

                       val++;

endif

---

That's actually my favorite way of explaining it.  Nice.