-
ID:XH9rg5 さんの質問

Javaとかでよくみかけるコメントアウトで引数や返り値を表現するのってどうやるんでしたっけ?
/*
@pram1
@pram2
@return
*/
みたいなかんじだったと思うのですが・・・

みんなの回答 1 件

ID:rfdTPG さんの回答

JSの事いってるのかな。
だとしたらJSDOCの書式の事いってるんだと思うけど、例えばランダムな値を返す関数だとしたらこんな感じ
/**
* return random number
* @param {Number} min Minimum number
* @param {Number} max Maximum number
* @return {Number} Between min and max
*/
function random(min, max) {
return min + Math.floor( Math.random() * max + 1);
}

Use JSDoc: Index

http://usejsdoc.org/
ID:rfdTPG

ちなみにこの書式でかいてれば、JSDOC toolkitという物を使えば、HTMLのドキュメントを自動生成できるよ。

ID:XH9rg5

たしかJavaだったことを記憶しているのですが、これも参考になります。

ID:rfdTPG

JavaならJavaDOC

ID:XH9rg5

とても勉強になりました。
すみません初歩的なところでお付き合いいただいて;
ありがとうございました!

ID:AuH3JX

それ大概の言語にあるから。
phpならPHPDOC

ID:rfdTPG

RubyのRdocは全然記法が違うよ

最終更新日:2014-06-19 (1,836 views)

関連するトピックス

ページ上部に戻る