• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

「WordPress インラインドキュメント規約」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(「アクセシビリティコーディング規約」の和訳完了)
(ja.wordpress.org へ移動)
 
1行目: 1行目:
<p class="important">注意: この記事は「[https://make.wordpress.org/core/handbook/ Core Contributor Handbook]」の「[https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/ Inline Documentation Standards]」(2016年8月18日時点)の訳です。<br />最新版については[https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/ 英語版]を参照してください。</p>
+
このページは https://ja.wordpress.org/team/handbook/coding-standards/inline-documentation-standards/ へ移動しました。
 
+
WordPress のインラインドキュメントは、将来の WordPress 開発に携わるコア開発者や、WordPress の学習を始めた開発者に対する優れた情報源です。また「[https://developer.wordpress.org/reference/ WordPress Developer Code Reference]」はインラインドキュメントから自動生成されています。
+
 
+
<p class="important">
+
'''自分のコードをドキュメントする意味が分かりません。コーディングしたのは全部自分なんだから、目をつぶってても分かります。'''<br />
+
 
+
ドキュメントは、開発者である、あなた自身のためと断言しておきます。私は何度も自分のインラインドキュメントに救われました。インラインドキュメントは作者の意図を読み取る場合、特に複雑な関数の引数や用法の場合に、とても有効な道しるべです。先日も2年ぶりに関数を変更した際、インラインドキュメントに慎重に書かれたコメントがあって、同じことを再発見する手間が省けました。 - Nacin
+
</p>
+
 
+
== リソース<span id="Resources"></span> ==
+
 
+
* [http://jaco.by/2012/06/04/inline-documentation/ Inline documentation] - なぜドキュメントしたほうが良いか
+
 
+
== 関連項目 ==
+
 
+
=== コーディング規約 ===
+
 
+
* [[WordPress コーディング規約]] ([https://make.wordpress.org/core/handbook/best-practices/coding-standards/ 原文: WordPress Coding Standards])
+
** [[PHP コーディング規約]] ([https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/ 原文: PHP Coding Standards])
+
** [[アクセシビリティコーディング規約]] ([https://make.wordpress.org/core/handbook/best-practices/coding-standards/accessibility-coding-standards/ 原文: Accessibility Coding Standards])
+
** [[CSS コーディング規約]] (翻訳予定) ([https://make.wordpress.org/core/handbook/best-practices/coding-standards/css/ 原文: CSS Coding Standards])
+
** [[HTML コーディング規約]] (翻訳予定) ([https://make.wordpress.org/core/handbook/best-practices/coding-standards/html/ 原文: HTML Coding Standards])
+
** [[JavaScript コーディング規約]] ([https://make.wordpress.org/core/handbook/best-practices/coding-standards/javascript/ 原文: JavaScript Coding Standards])
+
 
+
=== インラインドキュメント規約<span id="Language-specific_Standards"></span> ===
+
 
+
* [[WordPress インラインドキュメント規約]] ([https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/ 原文:Inline Documentation Standards])
+
** [[PHP ドキュメント規約]] ([https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/ 原文: PHP Documentation Standards])
+
** [[JavaScript ドキュメント規約]] ([https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/ 原文: JavaScript Documentation Standards])
+
 
+
 
+
最新英語版: [https://make.wordpress.org/core/handbook/ Core Contributor Handbook]  > [https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/ Inline Documentation Standards]
+
 
+
[[Category:WordPress の開発]]
+

2020年1月3日 (金) 19:14時点における最新版

このページは https://ja.wordpress.org/team/handbook/coding-standards/inline-documentation-standards/ へ移動しました。