Asynchronous 如何记录异步结果、异常?
Javadoc有明确的规则来记录返回值和方法引发的异常。但是对于从异步响应(如or)中返回/抛出的方法,我们应该怎么做 如果我使用Asynchronous 如何记录异步结果、异常?,asynchronous,javadoc,Asynchronous,Javadoc,Javadoc有明确的规则来记录返回值和方法引发的异常。但是对于从异步响应(如or)中返回/抛出的方法,我们应该怎么做 如果我使用@throws来记录异步抛出的异常,IDE会抱怨该方法没有(直接)抛出异常。这是正确的,但方法不正确 如果我在@return部分记录异步抛出的一长串异常,那么生成的文档很难阅读 针对这种情况的最佳做法是什么?如果可能,请参考已建立的库作为示例。关于它的价值,我目前正在使用以下语法,但我不认为这是已建立的最佳实践: /** * @param symbol the na
@throws
来记录异步抛出的异常,IDE会抱怨该方法没有(直接)抛出异常。这是正确的,但方法不正确
如果我在@return
部分记录异步抛出的一长串异常,那么生成的文档很难阅读
针对这种情况的最佳做法是什么?如果可能,请参考已建立的库作为示例。关于它的价值,我目前正在使用以下语法,但我不认为这是已建立的最佳实践:
/**
* @param symbol the name of a stock ticker
* @return the price of the ticker
* <br> {@code @throws NullPointerException} if {@code symbol} is null
* <br> {@code @throws IOException} if an I/O error occurs
*/
public CompletionStage<BigDecimal> getPrice(String symbol);
/**
*@param symbol股票代码的名称
*@返回股票代码的价格
*
{@code@throws NullPointerException}如果{@code symbol}为空
*
{@code@throws IOException}如果发生I/O错误
*/
公共CompletionStage getPrice(字符串符号);
我的指引如下:
- 异步抛出所有异常,即使是参数预条件之类的即时失败。这允许客户端将错误处理集中在一个地方
- 使用开发人员熟悉的
语法,在@throws
下记录异常@return