Page 181 - การเขียนโปรแกรมบนมาตรฐานเปิด
P. 181

181


               ตัวอย่างของ Doc documents มีดังนี้


               /**


               /** The Example class provides …

               */


               Public Example class { …


               5. การประกาศ (Declaration)


                       5.1 จ านวนของการประกาศต่อบรรทัด


                       แนะน าให้มีการใช้ 1 การประกาศต่อ 1 บรรทัด เนื่องจากสามารถคอมเมนต์ได้ง่าย ตัวอย่าง เช่น

               Int level;            //  indentation level


               Int size              // size o table


                       การประกาศในตัวอย่างด้านบนเป็นการประกาศที่เหมาะสมหว่าประกาศในตัวอย่างด้านล่างซึ่งเป็นการ

               ประกาศในบรรทัดเดียวกัน


               Int level, size;

               ไม่ควรประกาศข้อมูลคนละชนิดไว้ในบรรทัดเดียวกัน


               In foo, fooarray; // ประกาศผิดวิธี


                       5.2 ต าแหน่งของการประกาส


                       วางต าแหน่งของการประกาสไว้ที่ต าแหน่งเริ่มต้นของบล็อก ไม่ควรรอจนมีการเรียกใช้ ตัวแปรจึงค่อยท า

                                                        ั
               การประกาศตัวแปรเนื่องจากอาจท าให้เกิดความสบสนขึ้นได้ ตัวอย่างของต าแหน่งการประกาศตัวแปรมีดังนี้
               Void myMethod() {


               Int int1 = 0;   // beginning of Method block


               If (condition) {


                       Int int2 = 0;   // beginning of “if’ block

                       …
   176   177   178   179   180   181   182   183   184   185   186