Javaではjavadocがありますが
Ceylonもクラスやメソッドにドキュメントコメントを入れることで
IDEなどで表示されるようにすることが出来ます。
doc("カウンタ<B>太字</B>")
by("newta")
see(`class HogeClass`)
throws(`class Exception`)
class Counter(variable Integer i=0) {
// 省略 ...
}
byで作者を書きます。javadocではauthorですね。
seeで他に参照するクラスやメソッドがあれば書くことが出来ます。
バッククオートで囲み、
クラスを参照するときは「 class クラス名 」とすると参照できます。
クラスが無いとエラーになります。
メソッドや関数のときは「function メソッド名」などで参照出来ます。
こちらも名称がちゃんと合っていないとエラーになるので良いですね。
docは説明を書きます。
こちらはHTMLの一部タグを使ったりすることが出来ます。
詳しくはこちらのページで解説されています（英文）
http://daringfireball.net/projects/markdown/syntax
今回はBタグを使った箇所がちゃんと太字になっているのを見ることが出来ます。
docは省略して
ダブルクオートで囲むだけでもドキュメントとして認識されます。
"カウンタ<B>太字</B>"
class Counter(variable Integer i=0) {
// 省略 ...
}
クラスでもメソッドでも可能です。
戻り値それぞれにもコメントも付けることが出来ます。
"数値を足します"
Integer sum("１つ目の引数" Integer x,"２つ目の引数" Integer y) {
return x + y;
}
残念なのはreturn の値に対してコメントが出来ない気がするんですよね。。
自分の調査不足なのかもしれないので
returnへのコメントを付け方を知っている人がいたら教えてください！
あとは、まだIDEのプラグインサポートが弱くて
javaの設定のようにドキュメント書いてないと警告やエラーでお知らせ出来ないんですよね。
この辺は今後に期待でしょうか。。
そんな感じでドキュメントでした。
コードを書くならコメントもしっかり書かないとね！