search

Andover-Robotics / ARC-Core

This is the combined common code base for Andover Robotics Club, packaged in a library.
0 stars 9 forks source link

Global Style Guide #2

Open broad-well opened 6 years ago

broad-well commented 6 years ago

This issue is meant for discussion of choosing and customizing the global Style Guide that's utilized throughout. Note that once the standard style guide has been established, the project Code Style settings for Android Studio should always correspond to it.

What is a style guide?

A style guide standardizes the details of the code style of this project. Indentation, naming conventions, and syntax-based semantic expressions are among the topics dictated by the style guide.

broad-well commented 6 years ago

Google's Java Style Guide seems like a good starting point.

LakeYin commented 6 years ago

Motors and servos should be designated by motor or servo. If the motor/servo is used for movement, letters following should designate the position. For example: motorFL designates a front left motor. The front/back positioning should come first before left right. For motors and servos not part of movement, the following should be the role of the motor/servo and possible position designation if there are more than one. For example: servoWinchR designates a winch servo on the right.