函数重载,文档几乎相同

发布于 2024-11-15 04:37:41 字数 1539 浏览 5 评论 0原文

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

抱着落日 2024-11-22 04:37:41

我不了解 Doxygen,所以这个答案纯粹是我的文档方法。

当我在两个主题几乎相同的情况下进行文档记录时,我要么重复两个主题中的共享信息(首选),要么编写类似于以下内容的内容:

“函数 Y 与函数 X 类似。函数 Y 接受参数 abc 和[将其工作方式的不同方式放在这里]...

有关这些功能的更多信息,请参阅。”

在这种情况下,我将记录较简单的信息,并将附加信息添加到较复杂的信息中。

第三种方法是如果可能的话,从两者中分离出共同的文档。

I don't know Doxygen, so this answer is purely on my documentation approach.

When I document in a situation like where two topics are nearly identical, I either repeat the shared information in both (preferred) or I write something similar to the following:

"Function Y is similar to function X. Function Y takes the arguments abc and [put how it works differently here]...

For more information on these functions, see ."

In this case I'd document the simpler one and add the additional info to the more complex one.

A third way is to break out the common doc from both, if that's possible.

橘味果▽酱 2024-11-22 04:37:41

来自此页面

使用 \sa(请参阅另外)链接到相关变量、方法或类的关键字。这是与 \see tag 等效的命令。

From This Page:

Use the \sa (See Also) keyword to link to related variables, methods, or classes. This is the equivalent command to \see tag.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文