FiM ++プログラムの構造では、特定の方法で文字とコード作成者の名前を閉じることで終了する必要があります。
Dear Princess Celestia and Stack Exchange and String: A Sample:
...
Your faithful student, Southpaw Hare!
言語仕様によると、キーワード「あなたの忠実な学生」(コンマを含むが、次のスペースは含まない)がクラス定義の終了タグとして使用され、次の名前は構文上の影響のないコメントです。
著者がすべてのファイルに自動的に含まれているという事実(厳密に必要とされていない場合)は、Javaドキュメントに似た解釈可能なドキュメントの形式として使用できるかどうか疑問に思います。言い換えれば、他のプログラムや編集者はこの名前を解析して、何らかの方法で使用することができます。
そのような内部コメントベースのドキュメントの要件は何ですか?この特定のタイプの構文に問題を引き起こすものはありますか?
キーワードはテーマに合うのに十分ですか?「あなたの忠実な学生」を複数形で使用する能力がない場合(または、あいまいなバージョンの場合は「あなたの忠実な」または「あなたの真の」)、複数の著者のリストが不自然で不自然に見えることがあります(そして、自然な人間が書いた手紙のように見えることは、コアデザインパラダイムの1つです)。
Java Docs方法論の作成を検討した場合、他にどのような機能を含める必要がありますか?一つには、日付は一般的なようです。手紙の上部に何らかの形の日付コメントを含めると、おそらく自然に見え、設計パラダイムに反することはありません。
言語は新しく、ほとんどの人にはなじみがなく、正直なところ非常にばかげているので、考慮すべきいくつかのリソースがあります。