Doxygen命令段落(挂起)缩进限制
Doxygen command paragraph (hanging) indentation limitations?
多行(段落)命令的缩进量有限制吗?
考虑函数上下文中@details
的一个典型用例:
/**
* @brief Do foo.
* @details Lorem ipsum dolor sit amet, mentitum rationibus nec an.
* Usu magna eirmod et, aperiri discere volumus pri ex.
*
* Te pro alii vidit, cu nonumes mediocritatem duo.
* Paulo detracto tincidunt id vim, ad has oblique percipit.
*
* @tparam T The argument type.
* @param param1 The first parameter.
* @param param2 The second parameter.
* @return The return value.
*/
template< typename T >
inline
T foo( T const& param1, T const& param2 );
长的@details
段落必须被包装,这导致了对这个缩进有任何限制的问题?
我知道Doxygen使用Markdown,它有特定的缩进限制/用途,例如代码块的"4空格缩进"。在我想要插入代码的情况下,上面的缩进会混淆或冲突吗?
更普遍地说,是否还有我不知道的其他缩进用法和可能的冲突?
@托马斯·马修斯,这是一个关于技术限制的问题,而不是美学风格。
非常粗糙的建议,但这对我来说是有效的-
/**
* @brief Do foo.
* @details Lorem ipsum dolor sit amet, mentitum rationibus nec an.
*
* Usu magna eirmod et, aperiri discere volumus pri ex.
*
* Te pro alii vidit, cu nonumes mediocritatem duo.
* Paulo detracto tincidunt id vim, ad has oblique percipit.
*
* @tparam T The argument type.
* @param param1 The first parameter.
* @param param2 The second parameter.
* @return The return value.
*/
相关文章:
- 挂起和取消挂起一个文件DLL
- 如何防止C++遗留代码中的挂起指针
- clang格式:宏的缩进
- C++setiosflags函数操纵器-未确定的缩进
- 为什么所有C++编译器都会崩溃或挂起此代码
- 我编写了代码将十进制分数转换为其二进制等效数.它编译得很好,但在执行时挂起
- 构建挂起,即使是适度的文件大小
- 循环挂起迭代的 std::擦除 on std::list
- VSCode 中带有 C/C++ 扩展名的多行注释缩进错误
- Poco::Net::FTPClientSession 在 open() 方法上挂起 129 秒,如果 ftp 主机不存
- Node.js fs.open() 在尝试打开 4 个以上的命名管道 (FIFO) 后挂起
- 从不同进程中的另一个线程挂起/恢复线程或进程
- Boost (Beast) websocket:同步写入挂起
- 为什么析构函数挂起
- 使用互斥会挂起程序
- 在C++和 Python 程序中使用命名管道的 IPC 挂起
- 设置变量时C++程序挂起
- Emacs 是否可以在重新缩进缓冲区时将C++大括号转换为挂起
- 设置缩进宽度在咔嚓格式中不起作用
- Doxygen命令段落(挂起)缩进限制