Feature #1085

Feature #1083: Packngaを用いたドキュメントの書き方をまとめる

YARDのタグに優先順位をつける

Added by haruka yoshihara over 6 years ago.

Status:新規Start date:09/29/2011
Priority:NormalDue date:
Assignee:haruka yoshihara% Done:

0%

Category:-
Target version:-

Description

h2. 問題

YARDのドキュメントを書くにあたり、どのタグから説明がかかれるのか作業者以外の人からは分かりにくい。

h2. 期待する状態

作業者以外の人からみて、どのタグがドキュメント化されるのかがわかる。

h2. 解決方法

YARDのページ( http://rubydoc.info/docs/yard/file/docs/Tags.md#List_of\_Available\_Tags )を見てタグを抜き出して一覧にする

優先順位を決めて箇条書きにする(簡単な説明をできればつける)

packngaのwikiに貼り付ける(YARDによるドキュメントの書き方の頭)

Also available in: Atom PDF