いつもの業務中にメソッド名プラス数字というメソッドが乱発されていた。
ただ、これって改善したほうがいいのかと悩んだということに関して記事にさせていただく。
問題のコード
問題のコードと似た状態のコードを参考に記載させていただく。
import java.util.*;
public class Main {
public static void main(String[] args) throws Exception {
DoSomething1();
DoSomething2();
DoSomething(1);
DoSomething(2);
}
/**
* DoSomething1の説明
*
*/
public static void DoSomething1(){
//do somthing1
}
/**
* DoSomething2の説明
*
*/
public static void DoSomething2(){
// dosomthing2
}
/**
* DoSomethingの説明
*
*/
public static void DoSomething(int i){
switch(i){
case 1:
//doSomthing 1
break;
case 2:
//doSomthing 2
break;
}
}
}
自分としてはDoSomethingメソッドのほうでうまく処理を一つにして、変数名とかをうまいことDoSomethingのJavaDoc内へ記載すればいいかなって考えたんですが、案外見にくくなる可能性があるかなと思って。
一つのメソッドにまとめて引数として処理する方法の問題点
一番の問題点は、JavaDocの説明書きが長くなってしまうことであると思われる。
みんながみんな縦置きモニタなどという変態ツールを持っているわけではないので、
縦長の文章を永遠と読まされると結構うんざりしてしまう。
なので、JavaDocの文章はなるべく簡略するという点では、メソッドと引数でなんとか処理を考えるのではなく、
案外連番のメソッドなんていう冗長性の高そうなメソッドを作るのもありなのかなと思う次第である。
自分としての提案
連番は辞めて意味のある英語を使いませんか。
自分のプロジェクトローマ字変数、ローマ字メソッド名乱発の上、
詳細設計書とかは充実している割にそれをちゃんとみないと
JavaDocとかもちゃんと書かれていないので、結構ソースだけを見ていると
全然仕様がわからないんですが。
ソースと別に詳細設計書とかをエクセルで開くのも結構面倒ですし。
デュアルモニターとかを使うにしても視点移動が多くなり疲れるんですが。