在Javadocs中,我应该如何在<code>标签中编写单数对象的复数形式?

2022-09-01 02:25:38

我有一个名为 .在我的javadoc评论中,我将其引用为复数。我可以想到两种解决方案:将引用更改为 或 s。这些都感觉都不正确,我想知道是否有更好的解决方案。Identity<code>Identities</code><code>Identity</code>

为清楚起见,下面是一个示例:

/**
  * Returns an <code>IdentityBank</code> of <code>Identity</code>s with the given sex.
  */

/**
  * Returns an <code>IdentityBank</code> of <code>Identities</code> with the given sex.
  */

答案 1

听起来你想在这里做两件事:使用好的语法,但也要使用类的文字,逐字名称,以便javadoc的用户可以查找它们。

使用复数时可以做的一件事是使用短语“X实例”。因此,使用您的示例,您可以放置:

/**
 * Returns an <code>IdentityBank</code> of <code>Identity</code> instances with the given sex.
 */

如果需要指定值类型的复数形式(本身没有实例),则可以使用“X 值”。例如,您可以说“返回整型值的列表”。其他可接受的名称可能是“记录”、“注释”、“条目”、“通知”,或者@Marco13提到的“对象”。

应避免使用与框架、系统或应用程序中的现有艺术术语或类名冲突的术语,除非您正在使用该术语,因为它已被使用。例如,不要说“返回案例文件列表”,除非您指的是文件系统中的文字文件。使用它来引用文件的业务规则概念会增加混淆的可能性。出于这个原因要考虑避免的其他术语可能是“数据库”,“表”(除非引用数据库中的实际表或它们的抽象或表示形式),“页面”,“表单”,“工作表”,“驱动程序”,“端口”,“窗口”,“列表”,“堆”,“堆栈”,“应用程序”,“异常”(除非它们是可抛出的),“引脚”和“总线”。

同样,任何合理的名词如果符合代码的业务规则并且是可理解的,那么它都是有用的。您可以执行以下任一操作:

  • 返回 MapNode 条目的象限
  • 返回平衡的员工档案库

答案 2

使用“...(s)“ 样式的复数标签,带有 {@link} 到类:

/**
  * Returns an {@link IdentityBank} of {@link Identity Identity(s)} with the given sex.
  */

这将呈现为:

返回具有给定性别的身份

阅读起来很容易,更自然,而且你说的话也很明显。

无论如何,您都应该用于类。它负责样式格式设置,并提供指向实际类的 HTML 链接。{@link}<code>


您可以在链接对“(s)”进行编码,即 ,表示 的完全常规用法,但是在单词中间会有字体更改:{@link Identity}(s){@link}

返回具有给定性别的身份

恕我直言,这会降低清晰度并可能导致混淆。


推荐