いいものをつくろう

CTOの日記

documentation

e.g.って例えばって意味だけどコンマつけますか

投稿日:

ソースコードでも

よく登場する e.g.とかi.eとかa.k.a.っとか

私はかなり適当につかっていますした

例えばこんな感じ

parameter should be an animal. e.g) cat, dog or giraffe

でも 元々の意味はラテン語で「exempli gratia」といって例えば、英語でいえばfor exampleで、その省略なので

最低でもピリオドは両方に必要です

ということで e.g.

最後のピリアドをしっかりと書きましょう

 

さて、ここからは結論から言ってしまえば、正しい答えはなく流派的にわかれるところなのですが

コンマはつけますか?

という問い

Comma After i.e. or e.g.によると、British派はつけて、よりモダンなEnglishはつけない

というよなことを書いていますが、

結果、正解はないよう。

e.g.は for exampleの略なのだから ,が自然な場合は当然つけて

必要ない文脈ではつけない

という考えをもちました。

だから上の例では

parameter should be an animal. For example, cat, dog or giraffe

parameter should be an animal. e.g., cat, dog or giraffe

となるし

いきなり[ For instance ] みたいな場合だと [ e.g. ] でいいとおもう 。ただしいきなりFor example っていうこと

なさげ、であれば[ examples  ] でいいやんってなるので、基本はe.g., スタイルでいきます

 

私の場合はもちろんcoding styleで統一されていればどっちゃでもいいんですが

google styleguide for pyguideでの説明資料の中では

e.g.,

が多くつかわれていたので

こちらを使っていきます。

逆に言えば、同じドキュメント(google styleguide for pyguideでの説明資料)の中で

さえ

e.g. と e.g., の両方が混在していました。

 

まとめ

 

私は、基本は e.g., スタイルでいきます。

ただし、省略系の元の形、を意識して、

e.g.は for exampleの略なのだから ,が自然な場合が多い

という考えでいきます

 

以上です。

 

-documentation

Copyright© CTOの日記 , 2020 All Rights Reserved.