Vizible’s Blog

Code Conventions

Posted in Programming by wearetherock on October 23, 2008

Code conventions / Style conventions ไม่รู้ว่าแปลว่าอะไร  อาจเป็นข้อตกลง, ข้อแนะนำ, กฏ หรือธรรมเนียมปฏิบัติในการเขียนโค้ด เพื่อให้สามารถอ่านทำความเข้าใจได้ง่าย (วงจรการพัฒนาซอฟต์แวร์ 80% คือการ maintain ถ้าเขียนโค้ด style ใคร style มันใครจะอ่านของเรารู้เรื่อง ?หรือว่าโปรเจคหนึ่งเราอ่านของเราคนเดียว คนอื่นไม่ต้องมายุ่งและเราจะไม่ไปยุ่งกันโค้ดคนอื่น!!)

Code conventions
– การย่อหน้า ในภาษา Java แนะนำให้ย่อหน้า 8 ตัวอักษร (ไม่ใช่ 4)  แต่ภาษา Python ในการย่อหน้าใช้เพียงใช้ 4 ตัวอักษร  (ไม่ใช่ 8)
– ชื่อคลาส ในภาษา Java ให้ขึ้นตันด้วยตัวใหญ่ (เหมือนกันกับ Python)
– .. เยอะแยะ

Netbeans , Eclipse , MS-Studio สามารถแปลงโค้ดที่ยุ่งๆ ของเราให้ตรงกัน Convention ของภาษานั้นๆ ได้  (ยกเว้นตัวพิมพ์ใหญ่พิมพ์เล็กมันคงไม่ฉลาดพอจะมาแก้ให้เรา)

.. MS-Studio มันแปลงตอนเขียนโค้ดเลยแหละ แต่เขียนเสร็จ ถ้ายังเหลืออะไรที่ไม่เข้าที่เข้าทาง ไม่รู้จะคลิกตรงไหน?
.. Netbeans ไม่แปลงให้ เราต้องคลิกขวา -> Format เอง หลังจากนั้นทุกอย่างจะเคลียร์หมด
.. Netbeans เท่าที่เคยใช้ มันแปลงได้เฉพาะ Java กับ XML (ภาษาอื่นๆ คงขึ้นอยู่กัน Plugin)

เอกสารเพิ่มเติม
http://www.python.org/dev/peps/pep-0008/ (Code convention ภาษา Python)
– http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html (ของภาษา Java)

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: