- PR -

JAVAコメントに関わる問題をお願い

投稿者投稿内容
kingbigkyo
会議室デビュー日: 2005/05/16
投稿数: 5
投稿日時: 2005-05-16 14:56
新人です、中国人で、日本向けのオラクルアドオン開発をしております。
私が初めて書いた日本語のヘッダコメントで、自信がないです。文法的な間違いまたおかしいとこらがあるかどうか、どうかご指導をお願いします。
* 説明: このクラスはoracle.apps.jtf.um.ui.RegUiクラスを継承する。
* ページでユーザー入力したデータの検証を行う。
* ユーザー名の桁数の検証を行うために,親クラスに基づいて新しい検証ロジックを追加する。
* このクラスは追加されたvalidateUserNameLengthメッソドとすべて親クラスのプライベートメッソドを含む。
* publicなstatic定数ERROR_USER_NAME_LENGTHを追加する。
* validateメッソドとgetErrorMsgメッソドをオーバーロードする。
* validateメッソドに validateUserNameLengthメッソドを呼び出す。


[ メッセージ編集済み 編集者: 未記入 編集日時 2005-05-16 15:23 ]

[ メッセージ編集済み 編集者: 未記入 編集日時 2005-05-16 15:26 ]
るぱん
ぬし
会議室デビュー日: 2003/08/01
投稿数: 1370
投稿日時: 2005-05-16 15:05
るぱんです。
1点目
Copyright(c)は掲示板で質問する際は完全に削除しましょう。
お客さんの名前がFULLで出ています。

「あ〜あそこは質の低い外国人使ってるんだ・・・。」
ってな具合にお客さんを巻き込んで批判にさらされます。

2点目
「ページでユーザー入力したデータの検証を行う。 」
この記述以降もそうなのですが、
クラスの説明のコメントで
具体的過ぎる説明は無用です。

このクラスを使うとどういうメリットを受けられますか?
デメリットとして想定できることはなんですか?

この辺が書いてなければ、
再利用性云々の話が出た時に、
「このクラスは説明が悪いから使わないようにしよう」
だとか、
「修正したいんだが意味が不明」
となります。

そのクラスを使ってさせたい作業の概要を記述する様にしてください。

今の状態では僕は使いたいとは思いません。
敬称関係云々はJavaDoc吐き出させればわかる話です。

コメントはそれ以外のことを記述していてほしいですね。
kingbigkyo
会議室デビュー日: 2005/05/16
投稿数: 5
投稿日時: 2005-05-16 15:13
かたじけない、ありがとうございました。
これからもよろしく
るぱん
ぬし
会議室デビュー日: 2003/08/01
投稿数: 1370
投稿日時: 2005-05-16 15:21
くれぐれもこの掲示板のこのスレのCopyLightを修正してくださいね。

[ メッセージ編集済み 編集者: るぱん 編集日時 2005-05-16 15:28 ]
kingbigkyo
会議室デビュー日: 2005/05/16
投稿数: 5
投稿日時: 2005-05-16 15:26
ごめん、修正しました。
未記入
ぬし
会議室デビュー日: 2004/09/17
投稿数: 667
投稿日時: 2005-05-16 15:51
技術的なことは置いといて日本語だけ。

  • おかしいとこがあるかどうか おかしいとこがあるかどうか
  • メッソド メソッド
  • CopyLightを修正してくださいね Copyrightを修正してくださいね
未記入
ぬし
会議室デビュー日: 2004/09/17
投稿数: 667
投稿日時: 2005-05-16 16:25
おっと。大事なことを書き忘れていました。全体像が見えていないのではっきりしたことは言えないのですが、「validateメッソドとgetErrorMsgメッソドをオーバーロードする。」という部分は オーバーライドの間違いじゃないですか? なんとなく継承中心に話がかかれているのでスーパークラスのメソッド再定義の説明のように思いました。もし、本当にオーバーロードで正しいのだとするとメソッドシグニチャが記述されていないので意味が分かりませんし。

  • overload のことなら オーバーロード という表記で間違っていません。
  • override のことなら 日本語では オーバーライド と記述してください。
るぱん
ぬし
会議室デビュー日: 2003/08/01
投稿数: 1370
投稿日時: 2005-05-16 16:55
引用:

未記入さんの書き込み (2005-05-16 15:51) より:
技術的なことは置いといて日本語だけ。

  • CopyLightを修正してくださいね Copyrightを修正してくださいね



この部分は僕の記述ミスだと思います。
というか・・・記述方法きかれて、日本語のミスを指摘って
日本語が間違って伝わってるし。
どうなの?日本人って突っ込まれますよ。

コメントについて教えてください
→コメントについて教えてあげたらいいじゃないですか?

それ以外のことは蛇足になると思います。

スキルアップ/キャリアアップ(JOB@IT)