SphereScript言語仕様について

60：wakaba：2010/05/04(火) 09:15:41: >>57 電プロさん
素データありがとうございます。

そのテキストを元に書くとしたら以下でしょうか。
最初からコードに書いてしまえばそのまま配布するだけで済むので一石二鳥です。
# むしろSpsDoc摘用済みのmission.incなどが配布されればそれでデータの引渡し完了です。

元：
systemcall string string_head(string str, int n);
引数： str 取り出し対象の文字列
n 取り出す文字数
戻値：文字列strの先頭n文字からなる文字列
説明：文字列の先頭部分を取り出します。元の文字列は一切変更しません。2バイト文字は2文字として扱われます。

SpsDoc形式：
/**
* 文字列の先頭部分を取り出します。元の文字列は一切変更しません。2バイト文字は2文字として扱われます。
*
* @param string str 取り出し対象の文字列
* @param int n 取り出す文字数
* @return string 文字列strの先頭n文字からなる文字列
*
* @caption 文字列の先頭からの一部分を返す
* @since 1.0
* @version 1.0
* @engine RSE3.5
*/
systemcall string string_head(string str, int n);

"説明"が2行目、"引数"は@param、"戻値"は@returnになります。
1点だけ情報追加で必要で、@captionにその関数の簡単な説明を書いていただけると助かります。
それら以外はタダのフォーマットなのでコピペで使えます。

判らないことがありましたらhttp://rs.wakabadou.net/SpsDoc/を参照して頂ければと思います。
現時点でのSpsDocの正式な仕様です。

> 今回は無いですが、複雑な関数に関しては、「サンプルコード」が要るかもしれません。
別途管理でしょうか。
関数コメントには返すデータのデータ構造までは許されても、サンプルコードなどの具体は含まれるべきでないので。
# メンテ保障が出来ない。

> あと関数仕様以前に言語自体の仕様解説も要ると思った…。近いうちに書きます。
こんなのはいかが？ => http://rs.wakabadou.net/sps/
この先5年で出る不満を想定して書いているので現状の仕様には沿いませんが、ずれてる部分を直せばそのまま使えるはず。

※書き込む際の注意事項はこちら

※画像アップローダーはこちら

（画像を表示できるのは「画像リンクのサムネイル表示」がオンの掲示板に限ります）