effective scala の scaladoc の記述が気になった

1
Twitter Open Source @TwitterOSS

we are happy to #opensource our guide to Effective Scala. feel free to use, fork and contribute back if you can http://t.co/Emt4quU7 #scala

2012-02-08 02:58:43
Yuta Okamoto @okapies

あと、手伝ってくださる方を募集w 前から順番にやってるので、後ろのほうから節単位でpull requestして頂ければmergeいたします。forkしていただいてももちろん良いです。 #scala

2012-02-11 11:03:08
Kenji Yoshida @xuwei_k

日本語に訳してもこうなるよなぁ https://t.co/3pT2UkBf そうするとやっぱりこれ原文がちょっとおかしいというか、説明足りない気が https://t.co/oLVpLGVa

2012-02-11 12:44:11
Kenji Yoshida @xuwei_k

(JavadocにはないScaladoc独自の記法として) /** のあとに https://t.co/klbKYQsN paragraphを書く記法があるわけで、twitterのeffectivescala読むだけだとそのあたりが明確でないというか誤解を生みそうな書き方が

2012-02-11 12:46:50
Kenji Yoshida @xuwei_k

返信きた https://t.co/TYLcOzY1 けど、あんな英語じゃ言いたいこと伝わってないような(´・ω・`)?

2012-02-11 13:35:55
Kenji Yoshida @xuwei_k

2行目から書いても間違いじゃないんだろうけど「comment本文とparagraphを分ける必要ないときに、それを1行目に書くか2行目に書くか?」っていう細かいスタイル問題?

2012-02-11 13:38:12
Kenji Yoshida @xuwei_k

どっちにしろ"not the standard ScalaDoc style"って言い切っちゃうのはどうなの?とも思うけど、まぁもうちゃんと詳しく知りたい人は、公式のwiki https://t.co/klbKYQsN 読みましょうでいいか(´・ω・`)

2012-02-11 13:41:17
kmizu @kmizu

@xuwei_k Scaladoc記法として、 /** と同じ行に書くスタイルが許されている、どころか、そのような例が公式の最初のサンプルに出てくるのに、それが"not the standard ScalaDoc style" と行っちゃうのはまずいのでは、という話でしょーか?

2012-02-11 13:56:22
kmizu @kmizu

@xuwei_k There exists paragraph syntax in Scaladoc. It seems that "not skipping first line" is usual ScalaDoc style. とか。

2012-02-11 14:03:32
kmizu @kmizu

@xuwei_k 細かい点ですけど、 existは自動詞なので、Scaladoc exist paragraph syntax よか、 Scaladoc has paragraph syntax とかの方がいい気がしました。

2012-02-11 14:05:25
Kenji Yoshida @xuwei_k

@kmizu そうですね。同じ行に書くスタイルが「許されてる」だけなのか 「そもそも同じ行にparagraphをできるだけ書くべき」なのか、そのあたりの微妙なところが。それともあれは単に「twitterの中ではこういうstyleで書くことにしてます」という決まりなのか

2012-02-11 14:15:07
Toshiyuki Takahashi @tototoshi

Effective Scalaの "but not the standard ScalaDoc style:" のとこ、たしかにアスタリスクの位置が左にずれてるからstandardではないですね(細かい)

2012-02-11 14:23:34
Toshiyuki Takahashi @tototoshi

ScalaStyleGuideによればScalaDocのコメントは /** このすぐ横から書き始めて、*は┌ではなく┐と並ぶように書け http://t.co/v0zYgKEd ってこの前 #akskscala でやりました

2012-02-11 14:27:09
Toshiyuki Takahashi @tototoshi

わりとどうでもいいんじゃないかなって思います!!

2012-02-11 14:27:29
Kenji Yoshida @xuwei_k

(おそらくEitherはあとから他から入ってきたことも関係して) 同じファイル内でも、(おそらく特に理由もなく)styleバラバラだったりとか標準ライブラリ中でもそんな感じです! https://t.co/iZXPWmGW

2012-02-11 14:30:50
kmizu @kmizu

@xuwei_k 昨日のEffectiveScalaのscladoc コーディングガイドラインの話、コメントで補足してみたんですがが、 リプライがイマイチ要領を得ないですね。https://t.co/EeSOb8HG "standard" が (つづく)

2012-02-12 09:27:17
kmizu @kmizu

.@xuwei_k Scaladoc documentationで使われているところの、"standard"をさしているのだと、言っているのですが、これはEffective Scalaのガイドラインと整合性が取れない気がするんですよね。自分がうまく意図を伝えられなかったのか…

2012-02-12 09:28:34