2.7 CommentsAs programs get bigger

2.7 Comments
As programs get bigger and more complicated, they get more difficult to read. Formal
languages are dense, and it is often difficult to look at a piece of code and figure out what
it is doing, or why.
For this reason, it is a good idea to add notes to your programs to explain in natural language
what the program is doing. These notes are called comments, and they start with
the # symbol:
# compute the percentage of the hour that has elapsed
percentage = (minute * 100) / 60
In this case, the comment appears on a line by itself. You can also put comments at the end
of a line:
percentage = (minute * 100) / 60 # percentage of an hour
Everything from the # to the end of the line is ignored—it has no effect on the execution of
the program.
Comments are most useful when they document non-obvious features of the code. It is
reasonable to assume that the reader can figure out what the code does; it is more useful to
explain why.
This comment is redundant with the code and useless:
v = 5 # assign 5 to v
This comment contains useful information that is not in the code:
v = 5 # velocity in meters/second.
Good variable names can reduce the need for comments, but long names can make complex
expressions hard to read, so there is a tradeoff.

ผลลัพธ์ (ไทย) 1:

2.7 ความคิดเห็นเป็นโปรแกรมขนาดใหญ่ และซับซ้อนมากขึ้น พวกเขาได้ยากต่อการอ่าน อย่างเป็นทางการภาษาที่มีความหนาแน่น และมักจะยากที่จะดูที่ชิ้นส่วนของรหัส และคิดว่าดำเนินการ หรือทำไมด้วยเหตุนี้ มันเป็นความคิดดีเพื่อเพิ่มบันทึกย่อของคุณโปรแกรมจะอธิบายในภาษาธรรมชาติสิ่งโปรแกรมจะทำ หมายเหตุเหล่านี้เรียกว่าข้อคิดเห็น และพวกเขาเริ่มต้นด้วยสัญลักษณ์#:อันดับคำนวณเปอร์เซ็นต์ของชั่วโมงที่ได้ผ่านไปเปอร์เซ็นต์ = (นาที * 100) / 60ในกรณีนี้ ข้อคิดเห็นปรากฏบนบรรทัด ด้วยตัวเอง นอกจากนี้คุณยังสามารถใส่ข้อคิดเห็นในตอนท้ายบรรทัด:เปอร์เซ็นต์ = (นาที * 100) / 60 #เปอร์เซ็นต์ของชั่วโมงจาก#การสิ้นสุดของบรรทัดจะถูกละเว้น — มันไม่มีผลต่อการดำเนินการโปรแกรมความคิดเห็นมีประโยชน์มากเมื่อพวกเขาคุณลักษณะที่ไม่ชัดเจนของรหัสเอกสาร มันเป็นเหมาะสมที่จะสมมติว่า ผู้อ่านสามารถหารหัสอะไร เป็นประโยชน์มากขึ้นอธิบายเหตุผลความคิดเห็นนี้จะ มีรหัสซ้ำซ้อน และไร้ประโยชน์:v = 5 อันดับ 5 กำหนดให้ vความคิดเห็นนี้ประกอบด้วยข้อมูลที่ไม่อยู่ในรหัส:v =ความเร็ว 5 #เมตร/ที่สองชื่อตัวแปรที่ดีสามารถลดความต้องการข้อคิดเห็น แต่ชื่อยาวสามารถทำให้ซับซ้อนนิพจน์ที่ยากต่อการอ่าน เพื่อให้มีการถ่วงดุลอำนาจ

ผลลัพธ์ (ไทย) 2:

2.7 ความเห็น
ในฐานะที่เป็นโปรแกรมที่ได้รับใหญ่และซับซ้อนมากขึ้นพวกเขาได้รับยากมากที่จะอ่าน อย่างเป็นทางการ
ภาษาที่มีความหนาแน่นสูงและมันก็เป็นเรื่องยากที่จะมองไปที่ชิ้นส่วนของรหัสและคิดออกว่า
จะทำหรือทำไม.
ด้วยเหตุนี้มันเป็นความคิดที่ดีที่จะเพิ่มบันทึกในโปรแกรมของคุณที่จะอธิบายในภาษาธรรมชาติ
ว่า โปรแกรมจะทำ บันทึกเหล่านี้จะเรียกว่าการแสดงความคิดเห็นและพวกเขาเริ่มต้นด้วย
สัญลักษณ์ #:
# คำนวณร้อยละของชั่วโมงที่ได้ผ่านไป
ร้อยละ = (นาที * 100) / 60
ในกรณีนี้ความคิดเห็นนั้นปรากฏบนบรรทัดด้วยตัวเอง นอกจากนี้คุณยังสามารถใส่ความเห็นในตอนท้าย
ของเส้น:
ร้อยละ = (นาที * 100) / 60 # เปอร์เซ็นต์ของชั่วโมง
ทุกอย่างจาก # ไปยังจุดสิ้นสุดของเส้นจะถูกละเว้นมันมีผลกระทบต่อการดำเนินการของ
โปรแกรม
ความคิดเห็นที่มีประโยชน์มากที่สุดเมื่อพวกเขาเอกสารคุณลักษณะที่ไม่ชัดเจนของรหัส มันเป็น
เหตุผลที่จะสมมติว่าผู้อ่านสามารถคิดออกว่ารหัสไม่; ก็จะเป็นประโยชน์มากขึ้นในการ
. อธิบายว่าทำไม
ความคิดเห็นนี้ซ้ำซ้อนกับรหัสและไร้ประโยชน์:
v = 5 # กำหนด 5 โวลต์
ความคิดเห็นนี้มีข้อมูลที่เป็นประโยชน์ที่ไม่อยู่ในรหัส:
v. = 5 # ความเร็วเมตร / วินาที
ตัวแปรที่ดี ชื่อสามารถลดความจำเป็นในการแสดงความคิดเห็น แต่ชื่อยาวสามารถทำให้ซับซ้อน
แสดงออกยากที่จะอ่านเพื่อให้มีการถ่วงดุลอำนาจ

ผลลัพธ์ (ไทย) 3:

2.7 แสดงความคิดเห็นเป็นโปรแกรมที่ใหญ่ขึ้นและซับซ้อนมากขึ้นพวกเขาได้รับยากที่จะอ่าน อย่างเป็นทางการภาษาเป็น โง่ และ มันมักจะเป็นเรื่องยากที่จะมองไปที่ชิ้นส่วนของรหัสและคิดออกว่ามันกำลังทำอะไร หรือทำไมด้วยเหตุผลนี้ มันเป็นความคิดที่ดีที่จะบันทึกเพิ่มไปยังโปรแกรมของคุณที่จะอธิบายในภาษาธรรมชาติสิ่งที่โปรแกรมจะทำ บันทึกเหล่านี้จะเรียกว่าความคิดเห็นและพวกเขาเริ่มต้นด้วยการ # สัญลักษณ์ :# คำนวณร้อยละของเวลาที่ผ่านไปร้อยละ = ( นาที * 100 ) / 60ในกรณีนี้ , ความคิดเห็นที่ปรากฏบนบรรทัดเอง นอกจากนี้คุณยังสามารถใส่ข้อคิดเห็นท้ายของบรรทัด :ร้อยละ = ( นาที * 100 ) / 60 # เปอร์เซ็นต์ของชั่วโมงทุกอย่างจาก # ไปยังจุดสิ้นสุดของบรรทัดจะถูกละเว้น มันไม่มีผลกระทบต่อการดําเนินการโปรแกรมความคิดเห็นที่มีประโยชน์มากที่สุดเมื่อพวกเขาไม่ ชัดเจน มีเอกสารของรหัส มันคือมีเหตุผลที่จะสมมติว่าผู้อ่านสามารถคิดออกว่ารหัส มันมีประโยชน์มากขึ้นกับอธิบายว่าทำไมความคิดเห็นนี้ซ้ำซ้อนกับรหัสและไร้ประโยชน์ :V = 5 5 5 # มอบหมายความคิดเห็นนี้ประกอบด้วยข้อมูลที่เป็นประโยชน์ที่ไม่อยู่ในรหัส :v = ความเร็วใน # 5 เมตร / วินาทีการตั้งชื่อตัวแปรที่ดีสามารถลดความต้องการสำหรับความคิดเห็น แต่ชื่อยาวสามารถทำให้ซับซ้อนสำนวนที่อ่านยาก ดังนั้นนี่เป็นข้อเสีย