พื้นฐานการเขียนโปรแกรม:คอมเม้นต์(comment)

จาก Theory Wiki
รุ่นแก้ไขเมื่อ 14:23, 14 ธันวาคม 2549 โดย 210.169.224.55 (คุย)
(ต่าง) ←รุ่นแก้ไขก่อนหน้า | รุ่นแก้ไขล่าสุด (ต่าง) | รุ่นแก้ไขถัดไป→ (ต่าง)
ไปยังการนำทาง ไปยังการค้นหา

เวลาเขียนโปรแกรม บางครั้งจำเป็นต้องเขียนคำอธิบายไว้ เพื่อให้สามารถกลับมาทำความเข้าใจกับโปรแกรมได้ ยิ่งถ้าเขียนโปรแกรมเป็นทีมแล้ว คำอธิบายโปรแกรมเป็นสิ่งจำเป็นมาก

ในภาษาC/C++นั้นมีวิธีเขียนคำอธิบายโปรแกรมได้สองแบบคือ

  • แบบบรรทัดเดียว จะเริ่มด้วย // ที่ไม่อยู่ใน String("...") และจบด้วยการขึ้นบรรทัดใหม่
  • แบบหลายบรรทัด จะเริ่มด้วย /* และจบด้วย */ โดยจะมีกี่บรรทัดก็ได้ และภายในจะมีอักษรเริ่มคำอธิบาย(/*,//)กี่ครั้งก็ได้เช่นกัน

โปรแกรมแบบไม่มีคำอธิบาย

int getsum(int input){
  for(int sum=input;--input;sum+=input);
  return sum;
}

โปรแกรมแบบมีคำอธิบาย

// Calculate sum of 1 to input
int getsum(int input){
  for(int sum=input;--input;sum+=input);
  // input will be decreased
  // loop will stop when input==0 
  return sum;
}