哪种文档系统使用这种格式?

时间:2015-01-16 04:31:23

标签: documentation documentation-generation

#pragma region INFO
/*
 * @ FUNCTION: GetSubStrBetween
 *
 * @ PARAMETER(s):
 *      [1st] std::string &in_Str = This paramter takes in a std::string, which
 *            is the string that contains the unknown sub-string.
 *
 *      [2nd] std::string in_A = This parameter takes in a std::string, which
 *            will be the beginning point of the unknown sub-string.
 *
 *      [3rd] std::string in_B = This parameter takes in a std::string, which
 *            happens to be the ending point of the unknown sub-string.
 *
 *      [4th] std::string in_out_SubStr = This parameter takes in a std::string,
 *            which will contain the unknown sub-string.
 *
 *      [5th] bool in_opt_Append = This optional* parameter takes in either a true
 *            or false value. If in_opt_Append = true, in_out_SubStr (see 4th
 *            param.) will append the unknown sub-str. Else, in_out_SubStr will be
 *            equal to the unknown sub-str. Note: The default value is false.
 *
 * @ RETURN VALUE(s):
 *      false = This function returns a false value because...
 *              - The length of in_Str/in_A/in_B is equal to 0.
 *              - The length of in_A/in_B is greater than or equal to the length
 *                of in_Str.
 *              - The length of in_Str is smaller than length of in_A + the length
 *                of in_B.
 *              - Unable to find in_A/in_B.
 *      true = Successfully found and return the unknown sub-str to in_out_SubStr.
 */
#pragma endregion INFO

它很干净,看起来非常有用。

1 个答案:

答案 0 :(得分:0)

#pragma region <region_name>
#pragma endregion <region_comment>

只是Visual Studio中的可折叠区域内容,允许您在大纲模式下查看源时折叠或展开块。

其中的文字与Visual Studio无关,与DoxygenGhost Doc或内置的Visual Studio内容等常见嫌疑人不匹配。

该代码作者的通知失败(遗憾的是,自2013年5月以来他们还没有在这里看到过),你可能只需要接受他们对他们的评论很挑剔,除非有人是谁知道他们头脑中的格式。