-1

私は次の質問に固執しています：

次のJavaクラスヘッダーとコードフラグメントを調べてください。

class ExamScript implements Comparable<ExamScript>
{
    private String studentName;
    private int mark;
    ...rest of class...

    /**
      * Compares this object with the specified object for e
      *@param e the object to be compared
      *@return -1 if object is less than the specified object
      *@return 0 if object is equal to the specfied object
     **/
       public int compareTo(ExamScript e)
       {
         if (mark < e.mark)
             return - 1;
         if (mark == e.mark)
             return 0;
         return 1;
       }
}

メソッドに適したドキュメントを提供しcompareToます。特に、このメソッドから返される値の意味を述べてください。

compareTo仕様に従ってメソッドのコードを記述します。

上記のようにコードを文書化して記述しました。ドキュメント/コーディングを少し改善できるかどうか、またはそれで問題がないかどうかを誰かに確認できますか？

4

2 に答える 2

1

必ず追加してください@returns 1 if e is greater than this object.

@returnsをより具体的にすることができます。上記で使用した形式を使用してみてください。また、コードを読んでも明らかでない場合は、マークとは何か、なぜそれが比較に使用されているのかを説明してみてください。

詳細については、 Oracleの標準を確認してください。

于 2012-04-28T19:07:08.730 に答える