我正在使用Atomineer 9.00 来格式化我的代码注释,但我很难确定返回类型是否const
存在。文档指出,对于MethodReturns , using%type%
将提供完整的返回类型(给出的示例是:) const int*
:
方法返回
用于为方法(VB 函数)的返回值生成描述的规则。在本节中可以使用以下特殊变量:
%type% 方法的返回类型 (const int*)
%typeBase% 方法的返回类型,不包括任何修饰符 (int)
但是,当我使用%type%
它时会省略const
. MethodReturns.xml 中的一个示例:
<Set desc="zzz A %type%" />
这将为该方法生成以下内容:
//! \brief Performs the action.
//! \return zzz an int.
int PerformAction();
//! \brief Performs the different action.
//! \return zzz an int.
const int PerformDifferentAction();
//! \brief Practise action.
//! \return zzz A std::string&
std::string& PractiseAction();
//! \brief Attempt action.
//! \return zzz A std::string&
const std::string& AttemptAction();
struct Success;
//! \brief Performs the action with tips action.
//! \return zzz A success*.
Success* PerformActionWithTips();
//! \brief Succeed at action.
//! \return zzz An int*.
const int* SucceedAtAction();
我已经尝试了所有其他变体:(%typeBase
来自 MethodReturns.xml)甚至%retTypeBase%
, %retType%
, %typeBase%
and %specialType%
(这些都在确定返回类型时在 Methods.xml 中记录方法时提到)但这些都不包括const
.
我还尝试了其他几种类型(double
和std::string
custom struct
),所以它不仅仅是int
.
正如您从上面的示例中看到的,我已经验证了我设置的描述肯定是被调用的描述。
此外,这似乎与 Parameters.xml 完全兼容(确定参数类型是否const
存在);但是,它似乎在 Methods.xml 中不起作用(%retType%
可用于使用修饰符确定返回类型)
如何确定方法是否返回 aconst
?