Attention: Answers.ros.org is deprecated as of August the 11th, 2023. Please visit robotics.stackexchange.com to ask a new question. This site will remain online in read-only mode during the transition and into the foreseeable future. Selected questions and answers have been migrated, and redirects have been put in place to direct users to the corresponding questions on Robotics Stack Exchange. Additional details are available here.

Adding Comments in a msg format file

ROS
msgs

asked 2013-08-20 03:29:19 -0500

This post is a wiki. Anyone with karma >75 is welcome to improve it.

I am a bit confused because at all the sample codes that I have seen on ROS wiki, I have seen that the comments are displayed above the code:

#Standard metadata for higher-level flow data types
#sequence ID: consecutively increasing ID 
uint32 seq
#Frame this data is associated with
string frame_id

Can I place comments infront of the code like:

 uint32 seq        #sequence ID: consecutively increasing ID  #Standard metadata 
 string frame_id   #Frame this data is associated with

Also if you are fine with both, which one is considered a good programming practice

edit retag flag offensive close merge delete

add a comment

1 Answer

Sort by » oldest newest most voted

answered 2013-08-20 03:36:44 -0500

TommyP
1339 ●44 ●56 ●72

updated 2013-08-20 03:37:08 -0500

I use the second variant but the disadvantage of that is that TAB is not treated as space properly so I have to untabify my files before saving them otherwise rosdoc_lite (or maybe doxygen) does not handle the file properly.

edit flag offensive delete link

Comments

I am exactly doing the same thing right now. I am untabbing all the comments in my files and adding spaces because tab is 8 characters and space is only 1 character

Gudjohnson ( 2013-08-20 04:01:30 -0500 )edit

add a comment

Question Tools

1 follower

Stats

Asked: 2013-08-20 03:29:19 -0500

Seen: 3,612 times

Last updated: Aug 20 '13

Adding Comments in a msg format file edit

1 Answer

Comments

Question Tools

Stats

Related questions

Adding Comments in a msg format file