常见文件类型的注释方式总结(CMakeLists.txt、yaml、cfg、launch和xml等文件)

1、CMakeLists.txt文件的注释

   (1)单行注释直接在行首添加#号即可;

   (2)块注释符号:#[[与]]结合使用,例如:
 

#[[
add_executable(${PROJECT_NAME} src/main.cpp)
target_link_libraries(${PROJECT_NAME} ${catkin_LIBRARIES})
]]

2、yaml文件注释

       行首添加#号进行注释,yaml文件不支持多行注释,如果需要多行注释,就在每行添加#即可。

3、cfg文件注释

       添加#号进行注释

4、launch文件注释

<!-- <node pkg="beginner_tutorials" name="talker" type="talker" /> -->		

        即<!--与-->相结合,该注释符号也可用于块注释。

5、xml文件注释

        和launch文件注释添加方式一样。

        顺便总结一下C/C++和Python语言的注释:

6、C/C++注释
   (1) //                            行注释
   (2) /* ... */                    块注释,不能嵌套
   (3) #if 0   ... #endif     使用预处理形式进行注释

7、Python注释

   (1) #                      行注释
   (2) '''     ...     '''      多行注释用三个单引号 ''' 或者三个双引号 """ 将注释括起来

猜你喜欢

转载自blog.csdn.net/JIEJINQUANIL/article/details/106414288
今日推荐