C++17中unsigned int constexpr触发Sphinx解析警告的低侵入修复方案

最低侵入修复方案 #

直接调整constexpr的位置，将返回类型写法从unsigned int constexpr改为constexpr unsigned int即可，示例如下：

/**
 * Get the nucleus mass number A.
 *
 * @param code for nucleus
 * @return constexpr unsigned int
 */
inline constexpr unsigned int get_nucleus_A(Code const code) {
  return (static_cast<CodeIntType>(code) % 10000) / 10;
}

该修改完全符合C++17语法规范，constexpr作为函数说明符本身就支持放在返回类型前后两种写法，仅调整顺序不会对代码功能、编译结果产生任何影响，侵入性几乎为零，也不需要修改实际的返回值类型。

问题原因 #

你使用的Sphinx 3.5.3版本内置的C++声明解析器存在语法兼容缺陷，仅能识别constexpr位于返回类型左侧的写法，无法处理constexpr放在类型说明符之后的情况，会把原声明错误识别为unsigned constexpr int的非法顺序，从而抛出解析错误警告。

其他可选方案 #

如果不想调整代码写法，也可以选择以下两种方案：

• 屏蔽对应警告：在Sphinx的conf.py配置文件中添加 suppress_warnings = ["cpp.parsing_error"] 即可屏蔽这类解析警告，但该方案会同时屏蔽真正的C++语法错误警告，不推荐长期使用。
• 升级依赖版本：将Sphinx升级到4.0及以上版本，同时搭配Doxygen 1.9.2及以上版本，后续版本已经修复了C++说明符顺序的解析bug，不需要修改业务代码即可解决问题。

内容的提问来源于stack exchange，提问作者Ralf Ulrich