エンジニアのためのJavadoc再入門講座
自分も相当なJavadoc厨と自負しておりますので,内容をあらためねばと超上から目線で立ち読みしてきたら,{@code}タグやら@{literal}タグなど,知らないタグが書いてあって,恥ずかしい思いをしたでありますの巻。
慢心はいけませんね。:-P
今までJavadocの書き方といえば「How to Write Doc Comments for the Javadoc Tool」くらいで,とっても良いこと書いてあるのに読んでくれる人は少なくて悲しい思いをしたもんだが,日本語で解説してある本書がでたから,もう安心だね。遠慮して「再入門講座」ってあるけど「再」は余計だよね,つーか,みんなJavadocナメ過ぎ。あれは,相当デキる子なんですよ。
思い返せば,うんこなJavadoc(を作っているプロジェクト)に対する不満は山のようにあるが,そんなの書いてもしようがないので,「Javadoc,よくわかんね」って人は,とりあえず買っとくといいよっ!!
エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方
- 作者: 佐藤竜一
- 出版社/メーカー: 翔泳社
- 発売日: 2009/06/30
- メディア: 単行本(ソフトカバー)
- 購入: 15人 クリック: 263回
- この商品を含むブログ (49件) を見る
ps.
結局のところ,ドキュメントの質なんてのは,書き手が読み手のことをどんだけ考えてあげれるかに左右されるからねぇ。こればっかはお作法だけでは身に付かんけど。:-(
mapコマンドがないから,コード直接いじってオレオレIdeaVIMを作ったよ
Sendai.vimでvim力を補充してきたので,IDEA8でちょいと不調だったIdeaVIMにパッチ充ててみる。
...つもりだったのだが,ハメを外しすぎていつの間にかオレオレIdeaVIMを作っているの巻。
とりあえず,IdeaVIM on IDEA8の不調と,その応急処置について。
- GotoメニューのBack/Forwardで明後日な方向に移動してしまう。
- RegisterActionクラスから VimBack/VimForward の登録をコメントアウトしとく。
- なんか知らんがIndexOutOfBoundsExceptionがでてる。
- SearchGroup.EditorSelectionCheckクラスのselectionChanged()の中身をコメントアウトしとく。
IDEA7→IDEA8で何かが変わったらしく,IdeaVIMの検索・置換系コマンド(/, ? やExの s)はほぼ全滅してますんで,ご注意を。
直してみようかと思ったけど,一筋縄じゃムリそうだったんで,サクっと方針変換。IdeaVIMの検索系がダメならIDEA標準のコマンドにremapしてまえ,と思いRegisterActionをいじってこんな風にremapしてみた。
viコマンド → | remapしたIDEAのコマンド |
---|---|
/ | Search->Find |
? | Search->Find |
* | Search->Highlight Uages in File |
# | Search->Highlight Uages in File |
これがまた,思いの外快適。いい気になって,他のIDEAコマンドもvim風にremapしまくって,本来の目的を大きく逸脱してしまった。:-)
ちなみに,このオレオレremapの良いところは,キーコンビネーション系のショートカットに余裕ができる事。たとえば,Goto系の「Goto Files/Goto Class/Goto Symbol/Find Action/Recent Files」あたりは「SHIFT+ALT+F/SHIFT+ALT+C/SHIFT+ALT+S/Ctrl+SHIFT+A/Ctrl+E」に設定してたんだが,これを「,e/,c/,s/,a/,b」にremap。キーコンビネーションの空きは増えるわ,覚えやすいわで良いことづくし。
調子に乗ってExコマンドも増やしたれ,と思ったところで正気に戻った。:-)
ps.
こうやって,vim以外のエディタが使えない体になっていくんだな...。