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

179

ไว้ภายใน methods โดยที่หากมีการเขียน Block Comment ไว้ภายในฟังก์ชันหรือ methods ควรมีการย่อ

หน้าให้ Comment อยู่ในระดับเดียวกันกับ code ที่อธิบาย

ั
ตัวอย่างของBlock comments มีดงนี้
/*-

*Here is a block Comment with some very special

* Formatting that i want indent(1) to ignore.

*

*one
* two

* three

*/

4.1.2 comment แบบบรรทัดเดียว (Single-line Comments)

Single-line Comments เป็นคอมเม้นสั้นๆที่สามารถเขียนให้อยู่ในบรรทัดเดียวกันได ้

ด้วยควรจัดระยะย่อหน้าให้อยู่ในระดับเดียวกันกับ code ที่จะเขียนตามมา

ตัวอย่างของคอมเมนต์แบบบรรทัดเดียวมีดังนี้

if(condition) {

/*Handle The connection.*/

...

!

4.1.3 Trailing comments

เป็น comment ที่สั้นมากและสามารถอยู่บนบรรทัดเดียวกันกับcodeที่อธิบายได้ ด้วยควรเว้นระยะห่าง
จากตัวให้เหมาะสมเพื่อป้องกันความสับสนในกรณีที่มีการใช้ trailing comments เป็นจ านวนมาก ควรจัดระดับ

ของ Comment ให้ตรงกัน