Difference between revisions of "IGVC Software Standards"

From RoboJackets Wiki
Jump to navigation Jump to search
(Created page with "== Introduction == We strive to follow all of the ROS standards with a couple deviations listed below. If not explicitly mentioned on this page refer to the ROS standards. *[...")
 
Line 7: Line 7:
 
*[http://www.ros.org/reps/rep-0103.html\ Coordinate Frames]
 
*[http://www.ros.org/reps/rep-0103.html\ Coordinate Frames]
 
*[http://www.ros.org/reps/rep-0105.html\ Link Naming Conventions]
 
*[http://www.ros.org/reps/rep-0105.html\ Link Naming Conventions]
 +
 +
=== Comments ===
 +
Comment should describe the intent of the code not explain every syntactical oddity. If you feel that a certain line needs extensive explanation then you likely should reconsider that line.

Revision as of 13:17, 2 January 2018

Introduction

We strive to follow all of the ROS standards with a couple deviations listed below. If not explicitly mentioned on this page refer to the ROS standards.

REP Guidelines

Comments

Comment should describe the intent of the code not explain every syntactical oddity. If you feel that a certain line needs extensive explanation then you likely should reconsider that line.