C++中的特殊注释

时间:2020-11-26 21:18:44

引子

        我们知道,在C++中常用“//”进行单行注释,用“/**/”进行多行注释,那什么是特殊注释?

介绍

        特殊注释是一些通用的,能够被编译器识别的特殊字符。比如说,我们常用的特殊注释有“TODO”、“FIXME”、“XXX”。

  • TODO:“TODO: + 说明”可以用于提醒阅读者(或自己)此处有一些功能代码待实现,具体功能在说明中简要介绍。
  • FIXME:“FIXME: + 说明”可以用于说明标识处的代码需要修正,比如我们已经对某个功能进行了实现,但是有一些bug需要修复,那么可以用这个符号进行标明。
  • XXX:“XXX: + 说明”可以用于表示此处代码虽然实现了某个功能,但是实现方法有待商榷,需要改进,比如计算复杂度太高,需要优化等。

结束语

        以上这几个标识在编译器或某些编辑器(比如gedit)中通常会高亮显示,这使得我们更加清楚下一步应该做什么,代码中还有哪些地方需要完善,所以,是值得推荐的好技巧~