WordPress インラインドキュメント規約

WordPress のインラインドキュメントは、将来の WordPress 開発に携わるコア開発者や、WordPress の学習を始めた開発者に対する優れた情報源です。また「WordPress Developer Code Reference」はインラインドキュメントから自動生成されています。

自分のコードをドキュメントする意味が分かりません。コーディングしたのは全部自分なんだから、目をつぶってても分かります。
ドキュメントは、開発者である、あなた自身のためと断言しておきます。私は何度も自分のインラインドキュメントに救われました。インラインドキュメントは作者の意図を読み取る場合、特に複雑な関数の引数や用法の場合に、とても有効な道しるべです。先日も2年ぶりに関数を変更した際、インラインドキュメントに慎重に書かれたコメントがあって、同じことを再発見する手間が省けました。

Nacin

言語ごとの規約 言語ごとの規約

Top ↑

参照 参照

Top ↑

最新英語版 最新英語版