如何在 C++ 中同时处理“模板”和“文档字符串”答案

【问题标题】：How to deal with 'Template' and 'Docstring' simultaneously in C++如何在 C++ 中同时处理“模板”和“文档字符串”
【发布时间】：2021-12-15 00:47:20
【问题描述】：

编写具有关联模板和docstring的类定义以使其被IDE识别的标准顺序是什么？

是吗：

<docstring>
<template>
<class declaration/ definition>

或者：

<template>
<docstring>
<class declaration/ definition>

【问题讨论】：

任何带注释的注释的外观要求是相应的要求。博士。应使用的工具。（关于您的回答，这似乎是 doxygen。）所以，要回答这个问题，请查看该工具的手册。关于 C++，您选择哪种顺序绝对没有区别。对于 C++ 语言（和 C++ 编译器），cmets 被视为空白并分别进行处理。它们可用于分隔标记，并且不影响代码的语义。
仅供参考：Comments：评论作为一种代码内文档。当插入到程序中时，它们会被编译器有效地忽略；它们仅供阅读源代码的人用作注释。尽管特定文档不是 C++ 标准的一部分，但存在一些实用程序可以解析具有不同文档格式的 cmets。并且 在预处理器阶段之前删除了 cmets
我知道并且完全同意，你们都必须说什么。实际上，这个问题的目的不是展示文档字符串的有效位置，而是选择一个位置，以使 IDE 能够完美地识别文档字符串并在任何用户将鼠标悬停在相应实体上时正确显示它。
我已经在问题中进行了编辑并明确说明了这一点，以避免混淆，希望这能平息..

标签： c++ templates c++17 docstring

【解决方案1】：

template和docstring的标准排序方式如下：

文档字符串

模板

类声明/定义

示例：

/**
* Class of Traveling Salesman Problem : Ctor :-
* @param nov: order of Graph (|V|)
* @param startVertex: Starting Vertex for Hamiltonian Traversal
* @param costMatrix (optional): accepts cost matrix, if not provided, then one should call input() function
*/
template<typename DT>
class TSP
{
    ...
};

旁注：在 MS Visual Studio IDE 上验证的代码 sn-p 行为

【讨论】：