如何记录在javadoc中返回元组的方法？

Question

如何在javadoc中记录返回tuple的方法？例如：

    public Tuple2<Double,Double> arcadeDrive(double moveValue, double rotateValue, boolean ... sqrdRooted){
            //Code
            return new Tuple2<Double,Double>(leftMotorSpeed, -rightMotorSpeed);

我知道如何记录parameters以及所有内容，但我不确定我应该如何代表返回的tuple。到目前为止，我一直在使用与

类似的东西

/**
 * Commands for classic arcade drive.
 * 
 * @param moveValue The speed (-1.0 ~ +1.0) to move in the Y direction at.
 * @param rotateValue The speed (-1.0 ~ +1.0) to move in the Y direction at.
 * @param sqrdRooted Squares the inputs if true
 * @return (leftMotorSpeed, -rightMotorSpeed) Speed the Left motors are to be set to, Speed the right motors are to be set to
 */ 

Answer 1

我认为应该是：

@return新的元组对象 描述返回对象的用途

您并不需要插入整个变量类型。只是描述它正在返回什么以及为什么在正常的演讲中。