相変わらずドキュメントの執筆練習をしています。 …安西先生、コードが打ちたいです…(Java以外の)
ところで、"多数あるドキュメントの書き方を示したドキュメント" を読みながら作業しているのですが、サマリ (= summary) という単語が良く出てくる。『概要を書いてね』ってことでしょう。
しかしココで思い出す。 必死こいて執筆した*1修士論文にも、この論文で何をのたまっているかを解説した概要を書いてるんです。英文で。その時は "abstract" と呼ばれてました。
さらに思い出すと、doxygen でドキュメント自動生成できるよう特別なコメント記法を利用する場合、その識別子の概要を解説する為に "@brief 〜" なんて風に記述しています。
summary / abstract / brief
…違いは何かしら…?
summary
[名](複 -ries) 要約, (…の)摘要, 概括, (特に著作の内容をまとめた)結論*2(▼学術論文の概要はabstract;記事・本などの要約版はdigest;論文・文学作品などの摘要はsynopsis)
http://dic.yahoo.co.jp/dsearch?enc=UTF-8&p=summary&dtype=1&dname=1na&stype=0&pagenum=1&index=07049600
abstract
━━[名] /bstrkt/
1 抜粋, 抜き書き, 摘要, 要約;精髄(essence). ⇒SUMMARY[名]
http://dic.yahoo.co.jp/dsearch?enc=UTF-8&p=abstract&dtype=1&dname=1na&stype=0&pagenum=1&index=00025400
brief
━━[名]
1 簡潔な声明[文書], 摘要, 概要;(討議のための)要領書.
http://dic.yahoo.co.jp/dsearch?enc=UTF-8&p=brief&dtype=1&dname=1na&stype=0&pagenum=1&index=00956400
…えーっと ぶっちゃけ判らんのですけど(ぉ
今まで利用していた感じを含めて考えてみると、summary と abstract(と digest と synopsis)は兄弟分で、分野によって利用される単語が違うだけ。ある程度行数があっても良い。brief はマジ一言のみたいな解釈でいいのかしら…?
うーん…高校時代の英語の時間に
問題:"私は「や●パンは最高の職場なんじゃよ」と言います。" を英文にしなさい。
9「I say "や●パンは最高の職場なんじゃよ".」
友「めっさ日本語やん!」
9「だぶるくぉーてーしょん内は、2バイト文字も有効なんじゃ!アルファベット以外も有効な文字列なのじゃ!!!」
先生「HAHAHA!!」
(大きい丸をくれる)
なんてやらずに、しっかり英語をしっかりやっておけばよかったヨ。HAHAHA orz