基本の WordPress コーディング規約 / WordCamp Tokyo 2016 LT

WordCamp Tokyo 2016 での Lightning Talk セッションでの資料です。WordPress コーディング規約のエッセンスを伝えます。

Transcript

1. Akira Tachibana / 立花 明(@atachibana)
   Lightning Talk:
   WordPress Coding Standards At a Glance
   基本の WordPress コーディング規約
   

   View Slide

2. View Slide

3. 自己紹介
   • 立花 明
   • IT 関連会社勤務 (非 WordPress)
   • 好きなこと: 何かを集めること、並べること
   – 人生のモットー: これ以上集め始めない、並べ始めない
   • WordPress Document Team Member
   – Codex / HelpHub / Release Notes etc.
   • 2016年夏、WordPress コーディング規約を翻訳し
   ました。LT はその抜粋です。
   2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
   

   View Slide

4. LISTEN
   

   View Slide

5. Standards / 規約
   • WordPress オープンソースプロジェクトおよびコミュニ
   ティでのコラボレーションやレビューのベースライン
   • 適用範囲はコア、テーマ、プラグイン
   • 統一することで、ミスの削減、コードやドキュメントの
   可読性の向上、変更の容易化
   • 注意! 規約のためだけのリファクタリングは禁止
   2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
   

   View Slide

6. OBEY
   

   View Slide

7. Quote / 引用符
   2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
   Single ( ‘ ) Double ( “ )
   PHP ✔ ✔
   JavaScript ✔
   HTML ✔ ✔
   CSS ✔
   PHP: $a = ‘hello’;
   HTML:
   

   View Slide

8. THINK
   

   View Slide

9. Indenting / インデント
   2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
   if ( condition ) {
   action();
   }
   Tab !
   Not Space
   

   View Slide

10. TAB
    

    View Slide

11. Brace / 波かっこ
    2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
    if ( condition1 ) {
    action1();
    } elseif ( condition2 && condition3 ) {
    action2();
    action3();
    } else {
    defaultaction();
    }
    Always
    

    View Slide

12. ALWAYS
    

    View Slide

13. Space / 空白文字
    2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
    function func( $p1 = ‘x’, $p2 = ‘y' ) {
    ...
    foreach ( (array) $foo as $bar ) { ...
    $x = $foo[ $bar ];
    $x = $foo['bar'];
    $x = $foo[0];
    No Space!
    

    View Slide

14. (Almost)
    SPACE
    

    View Slide

15. Naming Convention / 命名規則
    • PHP
    –variable var_x (× camelCase)
    –class My_Hello
    –constant WINDOW_SIZE
    –PHP file my-plugin-name.php
    –class file class-my-hello.php
    2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
    

    View Slide

16. NO camelCase
    

    View Slide

17. Naming Convention / 命名規則
    • JavaScript
    –variable camelCase
    –class camelCase
    • CSS
    –separator #comment-form
    2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
    

    View Slide

18. camelCase
    

    View Slide

19. Yoda Conditions / ヨーダ条件式
    • If you miss typed “==“ as “=“, then
    2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
    if ( true == $the_force ) {
    $victorious = you_will( $be );
    }
    if ( true = $the_force ) => Error
    if ( $the_force = true ) => Run & Debug!?
    

    View Slide

20. May The
    Force Be
    With You
    

    View Slide

21. Third-person singular / 三人称単数
    2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
    /**
    * Displays simple message for a post.
    *
    * This is detail description about
    * below function...
    *
    * @global type $var_name Description.
    *
    * @param type $x Description.
    * @param type $y Optional. Description.
    * @return type Description.
    */
    

    View Slide

22. S
    

    View Slide

23. Reference / 参照
    • Core Contributor Handbook
    –WordPress Coding Standards
    –WordPress Inline Documentation
    Standards
    • Codex 日本語版
    –WordPress コーディング規約
    –WordPress インラインドキュメント規約
    2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
    

    View Slide

24. This LT
    was GREAT!
    

    View Slide

25. Thank You / ありがとうございました
    2016/9/17 WordCamp Tokyo 2016 Lightning Talk - WordPress Coding Standards
    

    View Slide