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

178

//หรือใช้การแบ่งบรรทัดในรูปแบบนี้ก็ได ้

If ((condition1&& condition 2) ll (condition3&& condition 4)

ll!( condition 5&& condition 6)) {
doSomethingAboutlt();

{

4.comments
การเขียนโปรแกรมภาษา Java นั้นสามารถสร้าง comment ได้ 2 รูปแบบคือ comment และ

Document preparation Comment โดยที่ implementation Comment คือ comment ที่สร้างขึ้นมาใน

ภาษา C + + ซึ่งใช้สัญลักษณ์ /*...*/ และ // ในขณะที่ Document preparation comments(หรือ "doc

comment)นั้นจะมีเฉพาะในภาษาJava เท่านั้น 1และใช้สัญลักษณ์ /**...*/ ซึ่งdocumentation comment

นั้นสามารถใช้ Java tool ดึงออกมาในรูป HTML files ได ้
Implementation Comment จะใช้คาอธิบายcodeหรือ อธิบายการใช้งานของโค้ชในขณะที่

Document preparation comment จะใช้อธิบายลักษณะโดยรวมของcodeซึ่งไม่เกี่ยวข้องกับการใช้งานโดยมี

เป้าหมายคือให้ผู้พัฒนาได้ท าความเข้าใจกับภาพรวมของcodeได้โดยไม่จ าเป็นต้อง source code

่
้
Comment ควรใช้ในการอธิบายภาพรวมของและให้ข้อมูลเพิ่มเติมจากข้อมูลที่อยู่ภายในโคดเพื่อชวยให ้
้
การอ่านและท าความเข้าใจโปรแกรมเป็นไปได้ง่ายขึ้นควรหลีกเลี่ยงcommentsที่อาจลาสมัยเมื่อโปรแกรมมีการ
พัฒนาขึ้น

หมายเหต ุ การใช้ Comment เป็นจ านวนมากบ่งบอกถึงคุณภาพของ code ที่ไม่ดีหากผู้เขียนโปรแกรม

รู้สึกว่ามีการใช้ comment เพื่ออธิบาย code มากเกินความจ าเป็นควรพิจารณาปรับปรุง

เพื่อให้ง่ายต่อการท าความเข้าใจไม่ควรเขียน comments เป็นบล็อกขนาดใหญ่ภายใน
เครื่องหมาย { } หรือมีตัวอักษรอื่นใน codeผสมอยู่ด้วย และ comments ไม่ควรมีอักขระ

พิเศษ เช่น เครื่องหมาย "\" อยู่ ในcomments

4.1 รูปแบบของ implementation Comment implementation comment formats)

สามารถใช้ comment ได้ 4 รูปแบบในการเขียนโปรแกรมภาษา Java
4.1.1 Block Comment

Block comment ใช้สาหรับเขียนคาอธิบายสาหรับ files, methods, โครงสร้างของข้อมูลและ

อัลกอริทึมเขียน Comment ไว้ที่ต าแหน่งเริ่มต้นของแต่ละ file และก่อนหน้า methods หรืออาจเขียน Block
comments ไว้ที่ต าแหน่งอื่นๆได้เช่นเขียน Block Comment