Minecraftとタートルと僕

PCゲームMinecraftのMOD「ComputerCraft」の情報を集めたニッチなブログです。

APIを作ろう(2)-初心者でも簡単に作れるAPI

はじめに

それでは、APIを作ってみましょう。
コツをつかめば誰でも簡単に作れます。

APIに名前をつける

ネーミングは、非常に重要です。
これをおろそかにすると使いづらくて仕方ありません。
働きを名前から想像できるように自然な名前をつけましょう。

僕の名付け方針

  • API名は、既存のAPIから連想してつけよう
    • turtleに関するAPIならturtleという文字列が入っているとわかりやすいよね。
    • 僕は既存API名の頭に「h2」をつけることにしました
    • hevohevo → hevo2 → h2
  • 変数名は原則として名詞にする
    • tbl_function、maxX、minY、color
  • 典型的な変数名
    • numberならn、for文の中の添え字はiとかjとか
  • 新しく定義する関数は、原則として動詞から名前が始まるようにするとその機能が想像しやすい
    • wrap、set、get などなど
  • boolean を返値とする関数は「is」から始まるように命名すること。
    • isPresent() => true or false

それでは以下に、標準の「Peripheral API」を拡張した「hevohevo Peripheral API」を作ります。
とりあえず関数は1つだけとして、以下の情報をしっかり押さえておきましょう。

  • 関数名
  • 関数の機能
  • 関数に与える引数
  • 関数から返ってくる返値
  • その他、使用上の注意
  • (さらにわかりやすくするために)実際の使用例、サンプルコードなど。

h2peripheral API 詳細

  • wrapByName( 機器名 )
    • 指定した名前の機器がすでに装着済み(隣接している)ならば、その機器を使えるようにする。
    • 引数は「機器名」(String)。機器名として次の文字列を受け付ける。
    • 返値は「その機器で使える関数テーブル」(Table)。内部的にperipheral.wrap()を使用。

(使用例)

mon = h2peripheral.detectByName("monitor")

mon.clear()

完成!

完成しましたよ。API作成って簡単でしょう?wwww

それでは「APIを作る」は終わります。お疲れ様でした。




















・・・え?ふざけるなって?
「APIは仕様である」という点では間違えてないでしょう?
APIは実装から切り離されているんですから。

今回のはじめに、「APIを作る」とは言いました。
でも「APIを実装する」とは言ってませんよwww





・・・手抜き記事ごめんなさい。

CC非公式wikiが動いている@wikiサーバーがメンテナンスで今日の夜までダウンしていたのですよ;;
CC公式Wiki(英語)見ればよいのだけど面倒くさくなって昼間からお酒を飲んでしまいました。

メンテはもう終わっているみたいですね。次回は早めに更新します。

広告を非表示にする