2005年6月18日
fooとbar
カテゴリー:
[プログラミング]
scp を Java から使いたかったので，Jsch という pure Java の SSH2 実装のライブラリを使おうとしてました．でも，Jsch には，これといってドキュメントはついていません．ただ，example コードがあるので，それを見れば使い方は，だいたいわかります．変なドキュメントよりはよほど有用です．（ドキュメントもほしいけど）
ただ，やはり一覧でAPIを確認したいので，javadoc はほしいわけです．もちろん，ソースがあるので，javadoc を生成することはできます．
でも，Javadoc コメントはないので，あまりまともなドキュメントになりません．もちろん，クラス名や，メソッド名，パラメータ名を見れば，理解の助けにはなります．
ちゃんと，名前が付いてさえいれば．．．
というのも，いくつかの重要なメソッドの引数の名前が，foo, bar とかになっていたのです．もちろん，ソースコードも foo や bar の羅列です．
おかげで，見ただけではパラメータに何を渡すべきかもわかりませんし，何をするメソッドかもわかりにくくなります．
example コードか，ソースコード自体を追っかけて，そのメソッドの使い方を探るしかありませんでした．
何でこんな名前になっているのか．普通わかりやすい名前にすると思うんですけどね．
投稿者 shingo : 2005年6月18日 03:48
トラックバック
このエントリーのトラックバックURL:
http://isolinear.info/cgi-bin/mt/mt-tb.cgi/121