CODECOMPOSER: Theia document formatting of comments

Keith Barkley

Guru 41995 points

Part Number: CODECOMPOSER

Tool/software:

When using auto format, it munges up comment blocks surrounded by OG comment delimiters. For example, if I have this comment:

/*
   Step Delay: a milliseconds delay between the movement of each servo.  Allowed values from 10 to 30 msec.
   M1=base degrees. Allowed values from 0 to 180 degrees
   M2=shoulder degrees. Allowed values from 15 to 165 degrees
   M3=elbow degrees. Allowed values from 0 to 180 degrees
   M4=wrist vertical degrees. Allowed values from 0 to 180 degrees
   M5=wrist rotation degrees. Allowed values from 0 to 180 degrees
   M6=gripper degrees. Allowed values from 10 to 73 degrees. 10: the tongue is open, 73: the gripper is closed.
  */

After right-click format document, I get this:

/*
  Step Delay: a milliseconds delay between the movement of each servo.  Allowed
  values from 10 to 30 msec. M1=base degrees. Allowed values from 0 to 180
  degrees M2=shoulder degrees. Allowed values from 15 to 165 degrees M3=elbow
  degrees. Allowed values from 0 to 180 degrees M4=wrist vertical degrees.
  Allowed values from 0 to 180 degrees M5=wrist rotation degrees. Allowed values
  from 0 to 180 degrees M6=gripper degrees. Allowed values from 10 to 73
  degrees. 10: the tongue is open, 73: the gripper is closed.
 */

The obvious work around is to use the newfangled // delimiter, but I would think that auto-format should just leave comments alone.

11 months ago

+1 Udit Kapoor 11 months ago

TI__Prodigy 220 points

Hi Keith,

Document formatting is handled by the clangd extension. The behavior can be modified using a `.clang-format` file. You can create a `.clang-format` file in your home directory and use the options specified here: https://clang.llvm.org/docs/ClangFormatStyleOptions.html.

Adding this line to the file should fix the issue and comments wouldn't be formatted.
ReflowComments: falseHope this helps!