ログ日記

作業ログと日記とメモ

英語のマニュアル的な文章の主語

英語での簡易的な説明の書き方が分からない。
検索しても主語は省略できない/しない方が良いというページばかりが出てくる。


かろうじてヒットしたのが

  • 一貫性があるように、関数の説明文字列の最初の文の動詞は 『to』を省いた不定詞にする。 たとえば、『Returns the cons of A and B.』ではなく 『Return the cons of A and B.』とする。 最初の行の残りの文についても同様にするとよい。 以降の文節では適切な主語があるほうが一般にはよい。
  • 説明文字列は受動態ではなく能動態で書き、未来形ではなく現在形で書く。 たとえば、『A list containing A and B will be returned.』ではなく 『Return a list containing A and B.』と書く。
http://www.geocities.co.jp/SiliconValley-Bay/9285/ELISP-JA/elisp_659.html

これ。
あと適当なJavadocを見れば分かるが

static void write(File file, CharSequence data, String encoding)
Writes a CharSequence to a file creating the file if it does not exist.

http://commons.apache.org/io/apidocs/org/apache/commons/io/FileUtils.html

こっちはsを付けている。


どちらにせよ、こういう英語の書き方を説明しているWebページか本ってあるのかな。
これらの場合、主語は「this function」や「this method」やインスタンス自身になる?


もう一つ、manコマンド。例えば man pwd

NAME
       pwd - print name of current/working directory

SYNOPSIS
       pwd [OPTION]...

DESCRIPTION
       Print the full filename of the current working directory.

       -L, --logical
              use PWD from environment, even if it contains symlinks

       -P, --physical
              avoid all symlinks

       --help display this help and exit

       --version
              output version information and exit

こっちは elisp と同様に s 無しタイプ。
これも「this command」や「this argument」が省略されている感じ?いや違うか… argument が output するわけじゃないもんね。
Google翻訳にかけたら、それっぽく主語無し日本語になる。


コマンドやソースの世界では何について説明しているか自明のときは主語を省略するのが普通っぽいが、普通の文章でも箇条書きなどの場合に使われているんだろうか。
ネットを探しても、主語を書けという説明ばかりで主語を省略するための説明が見つからない。