Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Variable Documentation #2

Open
Morgeno opened this issue Jan 7, 2014 · 0 comments
Open

Variable Documentation #2

Morgeno opened this issue Jan 7, 2014 · 0 comments

Comments

@Morgeno
Copy link
Contributor

Morgeno commented Jan 7, 2014

When you right click on a variable in the robot panel, you may open up the properties of said variable. In the properties panel there is a place to edit some information of the variable.

Whenever you update a variable, update this information.

This is the info that should be there:
What does the variable do?
Where is it plugged into?
What determines this variable?
What depends on this variable?

This way, if anyone is unsure of a variables purpose, or doesn't have time to search through every VI, they will be able to figure out what it does.

Additionally, remember to follow the naming standards when creating variables.

All of this will ensure that our code is clean, comprehensive, and allow us to minimize bugs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant