Hatena::Groupnadesiko

99円のへたれ学習帳

2008-08-19

なでしこのマニュアル

| 14:38

mrさんの記事をみて、やはりなでしこに不足しているのはマニュアルだと思いました。

mrさんの記事

 

たとえば、PHPのマニュアルではほとんどの関数引数と返値と説明がちゃんと書いてあって、使用例があります

http://www.php.net/manual/ja/function.md5.php

文字列の置き換えのような、使い方が簡単な関数にもちゃんと使用例があります

http://www.php.net/manual/ja/function.str-replace.php

マニュアルを書くのは確かにものすごく労力がかかりますが、命令数が多くても、使い方がわからなければ意味がありません。日本語なのでなんとなくカンでわかるのがなでしこのいいところですが、何かにハマってしまうと大変です。現状のなでしこのマニュアルでは、ほとんど使い方の説明がないのと、引数と返値の説明がすごく簡単に済まされています。また、代替命令なのについてもあまり書いていない気がします。

いうことで、マニュアルの執筆についても、何か議論があればなと思います・・・

#なでしこ2では命令の仕様をちゃんと定義してほしいです(^ ^;