はてなブックマーク

Scaladoc¶ 全てのパッケージ，クラス，トレイト，メソッド，その他のメンバにドキュメントを提供することはとても重要です。Scaladocは一般にJavadocの慣習に従いますが，記述を簡潔にすませるための機能が多数追加されています。 普通は，書式よりもその内容や書き方を気にしたいと思います。Scaladocは経験豊富なユーザと同様に初心者にも便利で無くてはなりません。この目的を達成する方法はとても単純です。すなわち，説明の詳細度を上げて，簡明な要約から始め（熟達したユーザの参考として有益です），詳細部ではより丁寧な例（熟練者は無視するかもしれませんが，初心者には何よりも貴重なものです）を提供することです。 Scaladocの一般的な書式は次の様なものです。 /** * これは何を説明しようとしているかの簡潔な記述です。 * * これは我々がドキュメント化しようとしているものを更に記述

Scalaスタイルガイド¶ EPFLの提供する公式スタイルガイドや，Artimaのようなコミュニティサイトによる非公式ガイドの代わりに，殆どの場合に従うべきScalaのスタイルにおけるガイドラインの概略を示す事を意図してこの文書は作られました。このガイドでは，なぜそのスタイルが推奨されるのか，またその代替案がどのようにしてそのスタイルに関連するのかを，できる限り多くの箇所で詳細に記述するよう努めています。他の全てのスタイルガイドと同様に，この文書もいずれ破られるルールの一覧として扱ってください。ここで提示するスタイルよりも好ましい別のスタイルがきっと現れるはずです。 コンテンツ:

Scalaスタイルガイド¶ EPFLの提供する公式スタイルガイドや，Artimaのようなコミュニティサイトによる非公式ガイドの代わりに，殆どの場合に従うべきScalaのスタイルにおけるガイドラインの概略を示す事を意図してこの文書は作られました。このガイドでは，なぜそのスタイルが推奨されるのか，またその代替案がどのようにしてそのスタイルに関連するのかを，できる限り多くの箇所で詳細に記述するよう努めています。他の全てのスタイルガイドと同様に，この文書もいずれ破られるルールの一覧として扱ってください。ここで提示するスタイルよりも好ましい別のスタイルがきっと現れるはずです。 コンテンツ:

命名規約¶ 一般に，Scalaは「キャメルケース」命名規約を用います。つまり，各単語（最初の単語は違うかもしれません）をその最初の文字を大文字にすることで区切ります。アンダースコア（_）はScalaの文法で特別な意味を持つため，使わないように厳しく自制してください。いくつかの重要な例外規則が，下に挙げたものの中にあることに留意してください。