使用 JavaDoc 记录 Map 的标准方法是什么?

2024-01-06

我正在记录一些代码,并且我有一个私有 HashMap。我想指定有关键和值的期望信息。现在我有:

/**
 * HashMap where key=word, value=part of speech
 */
private HashMap<String, String> dictionary;

然而,这似乎很难阅读,而且当我有更复杂的东西时,它也不会很好地工作,比如

HashMap<String, HashMap<String, String>>

记录地图的最佳/常见做法是什么?


如果您需要一个小的 javadoc,我建议如下:

/**
 * Dictionary is a {@link Map} collection that contains {@link Object1} as
 * key and {@link Object2} as value.
 */
private Map<Object1, Object2> dictionary = new HashMap<>();

@link keywork 将在实例定义上重定向您。

注意:应优先使用接口作为类型(Map 而不是 HashMap)。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

使用 JavaDoc 记录 Map 的标准方法是什么? 的相关文章

  • “源兼容性”和“目标兼容性”有什么区别?

    之间有什么关系 区别sourceCompatibility and targetCompatibility 当它们设置为不同的值时会发生什么 根据工具链和兼容性 https docs gradle org current userguide
  • 连接外部 Accumulo 实例和 java

    我正在尝试使用 Accumulo 连接到虚拟机 问题是 我无法将其连接到 Java 中 我可以看到 Apache 抛出的网页 但我无法让它与代码一起工作 我认为这是缺乏知识的问题而不是真正的问题 但我找不到这方面的文档 所有示例都使用 lo
  • 为什么在 10 个 Java 线程中递增一个数字不会得到 10 的值?

    我不明白 a 的值为0 为什么 a 不是10 那段代码的运行过程是怎样的 是否需要从Java内存模型来分析 这是我的测试代码 package com study concurrent demo import lombok extern sl
  • 以相反的顺序打印任何集合中的项目?

    我在 使用 Java 进行数据结构和问题解决 一书中遇到以下问题 编写一个例程 使用 Collections API 以相反的顺序打印任何 Collection 中的项目 不要使用 ListIterator 我不会把它放在这里 因为我想让有
  • 有人用过 ServiceLoader 和 Guice 一起使用吗?

    我一直想通过我们的应用程序 构建系统进行更大规模的尝试 但更高的优先级不断将其推到次要地位 这似乎是加载 Guice 模块的好方法 并且避免了关于 硬编码配置 的常见抱怨 单个配置属性很少会自行更改 但您几乎总是会有一组配置文件 通常用于不
  • 无法使用 datastax java 驱动程序通过 UDT 密钥从 cassandra 检索

    我正在尝试使用用户定义的类型作为分区键将对象存储在 cassandra 中 我正在使用 datastax java 驱动程序进行对象映射 虽然我能够插入到数据库中 但无法检索该对象 如果我更改分区键以使用非 udt 例如文本 我就能够保存和
  • 为什么用scala写的代码比用java写的慢6倍?

    我不确定我在编写 scala 代码时是否犯了一些错误 问题是 The four adjacent digits in the 1000 digit number that have the greatest product are 9 9
  • 从字典中绘制直方图

    我创建了一个dictionary计算 a 中出现的次数list每个键的内容 我现在想绘制其内容的直方图 这是我想要绘制的字典的内容 1 27 34 1 3 72 4 62 5 33 6 36 7 20 8 12 9 9 10 6 11 5
  • 如何更改 Swagger-ui URL 前缀?

    我正在使用 Springfox Swagger2 和 Spring boot 1 5 9 我可以通过此链接访问 swagger UI http localhost 8090 swagger ui html http localhost 80
  • 为什么解析这个 JSON 会抛出错误?

    我正在尝试解析这个 JSONObject query yahoo count 1 results rate Name USD INR id USDINR Time 12 19pm Date 10 31 2015 Bid 65 405 Ask
  • 如何在 IntelliJ IDEA 中运行 akka actor

    来自 Akka 网站文档 然后 这个主要方法将创建所需的基础设施 运行演员 启动给定的主要演员并安排 一旦主要参与者终止 整个应用程序就会关闭 因此 您将能够使用类似于以下的命令运行上面的代码 下列的 java classpath akka
  • 无需递归即可对可观察结果进行分页 - RxJava

    我有一个非常标准的 API 分页问题 您可以通过一些简单的递归来处理 这是一个捏造的例子 public Observable
  • 在java程序中使用c++ Dll

    我正在尝试使用System LoadLibrary 使用我用 C 编写的一个简单的 dll UseDllInJava java import com sun jna Library import com sun jna Native imp
  • 如何自定义舍入形式

    我的问题可能看起来很简单 但仍然无法得到有效的东西 我需要自定义 Math round 舍入格式或其他格式以使其工作如下 如果数字是 1 6 他应该四舍五入到 1 如果大于或等于 1 7 他应该四舍五入到 2 0 对于所有其他带有 6 的小
  • Android - 存储对ApplicationContext的引用

    我有一个静态 Preferences 类 其中包含一些应用程序首选项和类似的内容 可以在那里存储对 ApplicationContext 的引用吗 我需要该引用 以便我可以在不继承 Activity 的类中获取缓存文件夹和类似内容 你使用的
  • 按降序排序映射java8 [重复]

    这个问题在这里已经有答案了 private static
  • Groovy - 在对象实例化期间忽略映射中的额外属性

    有没有办法让 groovy 在对象实例化期间忽略映射中的额外属性 例子 class Banana String name def params name someGuy age 13 new Banana params 在这个例子中 gro
  • Spring Data Rest 多对多 POST

    首先 让我解释一下我的用例 这非常简单 有一个用户实体和一个服务实体 我使用 UserService 作为连接实体 连接表 在用户和服务之间建立多对多关联最初 会有一些用户集和一些服务集 用户可以在任何时间点订阅任何服务 在这种情况下 将向
  • 使用 DBCP 配置 Tomcat

    在闲置一段时间 几个小时 后 我们收到了 CommunicationsException 来自 DBCP 错误消息 在异常中 位于这个问题的末尾 但我没有看到任何配置文件中定义的 wait timeout 我们应该看哪里 在 tomcat
  • 在会话即将到期之前调用方法

    我的网络应用程序有登录的用户 有一个超时 在会话过期之前 我想执行一个方法来清理一些锁 我已经实现了sessionListener但一旦我到达public void sessionDestroyed HttpSessionEvent eve

随机推荐

  • 查找多个重叠矩形的并集 - OpenCV python

    我有几个包含单个对象的重叠边界框 但它们在某些地方重叠最少 作为一个整体 它们包含了整个对象 但是 openCV 的 groupRectangles 函数不会返回包含该对象的框 我拥有的边界框以蓝色显示 我想要返回的边界框在这里以红色显示
  • C#:当存在多个类型参数时,为什么泛型类型推断不起作用?

    这是两个示例 这工作正常 void Main var list Queryable ProjectTo typeof Projection public static class QueryableExtensions public sta
  • 负载均衡器后面的 SilverStripe

    我有一个 SilverStripe 实例在 AWS 负载均衡器后面的两台服务器上运行 为了共享会话信息 我正在运行 Elasticache Redis 服务器 我将我的 php 会话存储信息设置为 ini set session save
  • 使用 JavaScript 将 JSON 文件转换为 CSV

    我正在尝试使用 JavaScript 将 JSON 文件转换为可以在 Excel 中打开的 csv 我拥有的 function exportToCsv filename rows var processRow function row va
  • 如何调试 Node.JS 子进程?

    我正在尝试调试使用以下命令创建的子 Node JS 进程 var child require child process child fork dirname task js 问题是 当在 IntelliJ WebStorm 中运行时 父进
  • 未捕获的类型错误:dispatcher.useSyncExternalStore 不是函数

    我正在尝试使用 useSelector 和 useDispatch 更改 bulma 模型的状态像这样 const isState useSelector state gt state isActiveState Model js 是 im
  • GTK 程序运行时如何禁用屏幕保护程序/电源管理/屏幕消隐?

    问题 有没有办法阻止 X 会话启动屏幕保护程序 进入省电模式或通过代码执行屏幕空白 我正在做什么 语言 C C 图形用户界面框架 GTK3 硬件 树莓派3B 软件 Raspbian 10 Buster 我的程序需要在屏幕上长时间运行 最多
  • 如何对数据库依赖行为进行单元测试 C#

    我有一个与数据库通信的 C 应用程序 我想测试一些依赖于数据库的功能 所以我想确保数据库在每次测试运行之前都有一个初始状态 我使用 NUnit 来测试我的应用程序 有什么方法可以恢复DB的初始状态 感谢您的帮助 您不对与数据库的交互进行单元
  • Blazor WASM 启动时加载初始数据的最佳位置在哪里

    我正在构建 Blazor 应用程序 需要在应用程序启动时加载一些初始数据 以便我可以将数据放入 CascadingPerameter 中以供其他组件使用 我想知道调用服务来读取此数据的最佳位置在哪里 一般来说 您应该使用服务来获取数据 服务
  • 根据 ASP.NET MVC 中的控制器属性向视图模型添加错误消息

    我的控制器上有一个用于授权的自定义属性 其详细信息可以是在这里查看 https stackoverflow com questions 4342271 asp net mvc forms authorization with active
  • 使用 Flask-Script / Python 从标准输入读取

    现在我有flask script 命令 它将路径作为参数 然后从路径中读取 manager option f file dest file path def my command file path open file path 我希望它也
  • 如何制作动态选项菜单?

    问题是按下菜单按钮时会调用一次以下方法 public boolean onCreateOptionsMenu Menu menu 如何稍后重新创建菜单以更改某些选项 禁用某些选项等 覆盖这个 onPrepareOptionsMenu 菜单菜
  • 发送带有多个附件的电子邮件

    我正在尝试发送一封包含多个附件的电子邮件 Intent emailIntent new Intent Intent ACTION SEND MULTIPLE emailIntent putExtra Intent EXTRA EMAIL n
  • 使用python smtplib发送邮件错误

    我正在尝试使用 python 3 2 SMTPlib sendmail 函数 对 SMTP 库进行一些修改后 即 注释掉抑制错误消息的 rset 函数 我设法从服务器检索到以下错误消息 发送邮件失败 554 b 交易失败 由于可能滥用 无法
  • 触摸后保持 UIButton 处于选中状态

    用户单击按钮后 我希望在执行网络操作期间该按钮保持按下状态 当网络操作完成后 我希望按钮返回到默认状态 我试过打电话 UIButton setSelected YES 按下按钮后 相应地调用 UIButton setSelected NO
  • ERRO 003 尝试连接到本地对等点时出错:超出上下文截止时间

    继我之前的question https stackoverflow com questions 47699785 error error endorsing chaincode rpc error code unknown desc fai
  • Python:海量数据的 One-hot 编码

    我在尝试编码时不断遇到内存问题字符串标签到one hot编码 大约有 500 万行和大约 10000 个不同的标签 我已尝试以下方法 但不断出现内存错误 from sklearn import preprocessing lb prepro
  • 如何在我的 Powershell 脚本中使用 Jenkins 变量

    我通过编写了一个简单的脚本PowerShell收集一些文件并将它们压缩到一个文件夹中 我们称之为Script ps1 我想让脚本在每次 Jenkins 进行新构建时运行 但是我也希望 zip 文件的名称是BUILD NUMBER 我怎样才能
  • WPF 弹出窗口替代方案

    我有一个带有弹出窗口的窗口 当双击列表视图中的项目时会弹出该窗口 它以主窗口为中心 漂浮在那里看起来非常漂亮 问题是当用户移动主窗口或选择另一个程序时 弹出窗口会漂浮在其他内容之上 我想要一个类似弹出窗口的东西 这意味着它浮动在窗口中其他元
  • 使用 JavaDoc 记录 Map 的标准方法是什么?

    我正在记录一些代码 并且我有一个私有 HashMap 我想指定有关键和值的期望信息 现在我有 HashMap where key word value part of speech private HashMap