คำอธิบายในโปรแกรมภาษา C

คำอธิบายในโปรแกรม  (program  comment)  คือข้อความที่แทรกอยู่ภายในโปรแกรม  ซึ่งคอมพิวเตอร์จะไม่แปลข้อความนี้ให้เป็นส่วนหนึ่งของโปรแกรม  กล่าวคือจะไม่มีผลต่อการทำงานของโปรแกรม  เขียนไว้เพื่ออธิบายโปรแกรม  ซึ่งในบางครั้งผู้เขียนโปรแกรม อาจต้องการเขียนคำอธิบาย กำกับขั้นตอนการทำงานของโปรแกรมในแต่ละขั้น  ทำให้เกิดประโยชน์กับผู้เขียนและผู้ที่อ่านโปรแกรมได้เข้าใจง่ายขึ้น  และช่วยทำให้การแก้ไขและปรับปรุงโปรแกรมเป็นไปได้ง่ายยิ่งขึ้น

            โปรแกรมตัวอย่าง  แสดงการใส่คำอธิบายในโปรแกรมบรรทัดเดียว  โดยการใช้เครื่องหมาย  /*  หน้าข้อความที่อธิบาย  และใส่เครื่องหมาย  */  หลังสิ้นสุดข้อความที่อธิบาย

 จากโปรแกรมตัวอย่างข้างต้นมีคำอธิบายโปรแกรมดังนี้คือ    /*        The  first  program  with  C  */  เป็นการอธิบายโปรแกรมบรรทัดเดียว  บอกให้ทราบว่าโปรแกรมนี้เป็นโปรแกรมแรกที่เขียนด้วยภาษา  C

            โปรแกรมตัวอย่าง แสดงการใส่คำอธิบายในโปรแกรมมากกว่า  1  บรรทัด  โดยการใช้เครื่องหมาย  /*  หน้าบรรทัดแรกของข้อความที่อธิบาย  และใส่เครื่องหมาย  */  หลังสิ้นสุดข้อความที่อธิบายของบรรทัดสุดท้าย

    จากตัวอย่างข้างต้นมีคำอธิบายโปรแกรมดังนี้คือ    /*test.c  */ เป็นการอธิบายโปรแกรมบรรทัดเดียว  บอกให้ทราบว่าโปรแกรมชื่อ  test.c  และ

   /*This  program  is  to  show             
how  to  write  comments*/

            เป็นการอธิบายโปรแกรม  2  บรรทัด  แสดงให้เห็นถึงวิธีการใส่คำอธิบายในโปรแกรม

ข้อสังเกต  ในเอกสารเล่มนี้จะปรากฏการใส่เครื่องหมาย  /* …  */  เพื่ออธิบายโปรแกรมตลอดทั้งเล่ม  ซึ่งส่วนมากจะใช้บอกให้ทราบชื่อโปรแกรม  และบอกหมายเลขบรรทัดเพื่อใช้ประกอบการอธิบายโปรแกรม