มาพูดถึงพื้นฐานของนักพัฒนารายอื่นกัน และอันนี้กำลังแสดงความคิดเห็นโค้ดของคุณ
จนถึงตอนนี้ คุณอาจเคยเห็นฉันแสดงความคิดเห็น เพิ่มความคิดเห็นในสคริปต์ของเรา
ตัวอย่างเช่น ที่นี่ ฉันเพิ่มความคิดเห็นของบูลีน และสิ่งนี้บอกล่าม Python ว่า เฮ้ นี่คือความคิดเห็น
อย่าเรียกใช้สิ่งนี้
มันเป็นเพียงสำหรับฉัน
คุณสามารถเพิกเฉยและข้ามไปยังบรรทัดที่สองได้
แล้วคุณเห็นไหม
ฉันทำอย่างนั้นใน Python ด้วยเครื่องหมายปอนด์
ทันทีที่ Python เห็นเครื่องหมายปอนด์ มันจะเพิ่มความคิดเห็นและคุณสามารถทำได้หลังบรรทัดเช่นกัน
ฉันสามารถพูดได้ว่าสิ่งนี้กำหนดให้กับตัวแปร
และถึงแม้ว่านี่อาจดูเหมือนเป็นสองบรรทัด แต่จริงๆ แล้วเป็นเพียงการแร็ปวอร์ดที่กำลังเกิดขึ้น
และคุณจะเห็นได้ว่าล่ามไม่สนใจความคิดเห็นเหล่านี้โดยสิ้นเชิง
ตอนนี้ การแสดงความคิดเห็นดูเหมือนง่ายมาก แต่เป็นแนวคิดที่สำคัญ
และถ้าคุณต้องการเป็นโปรแกรมเมอร์ที่ดีในทุกภาษา เรามีความคิดเห็น
แต่มีวิธีที่ดีและวิธีแสดงความคิดเห็นที่ไม่ดี
และนี่คือสิ่งที่มาพร้อมกับการปฏิบัติ
แต่นี่เป็นแนวทางสำคัญบางประการ
เมื่อคุณแสดงความคิดเห็นโค้ดของคุณ แนวคิดก็คือคุณกำลังเพิ่มความคิดเห็นที่มีค่า
นั่นคือ ถ้าฉันเพิ่มความคิดเห็นที่นี่ว่า เฮ้ นี่คือตัวแปรชื่อเครื่องหมาย ค่าของสตริงอังเดร
ความคิดเห็นเช่นนี้
ไม่ดีจริง.
ทำไมถึงเป็นอย่างนั้น?
ก็เพราะรหัสของคุณควรอธิบายตนเองได้ใช่ไหม
แนวคิดคือให้เราเขียนโค้ดที่อ่านง่ายเข้าใจง่าย
ไม่ได้พยายามที่จะฉลาด
ควรอ่านเหมือนภาษาอังกฤษแทน
และโปรแกรมเมอร์หลามคนใดจะรู้ว่าที่นี่เราแค่เพิ่มอังเดรเป็นค่าของชื่อ
เรากำลังกำหนดตัวแปรและเพิ่มความคิดเห็นเช่นนี้ที่อธิบายตนเองได้
เพียงแค่เพิ่มความยุ่งเหยิงให้กับโค้ดของคุณ
ดังนั้นจึงมีข้อแลกเปลี่ยนที่นี่
เป็นการดีที่จะแสดงความคิดเห็นโค้ดของคุณ สมมติว่าคุณกำลังทำงานในทีมและนักพัฒนาคนอื่นๆ ก็เข้ามาและพวกเขาต้องการเข้าใจโค้ดของคุณ
แต่คุณต้องจำหลักการของโค้ดนี้ว่าอ่านง่าย
ครั้งเดียวที่คุณต้องการเพิ่มความคิดเห็นในโค้ดของคุณคือ
เมื่อมีบางสิ่งที่สำคัญจริงๆ เกิดขึ้น ซึ่งมันอาจจะซับซ้อนเล็กน้อย คุณต้องตัดสินใจก่อนว่า
เฮ้ รหัสนี้เขียนในลักษณะที่สมเหตุสมผลหรือไม่
ตัวอย่างเช่น หากเป็นตัวแปร a
และนี่คือตัวแปร B
มันอาจจะยากสำหรับคนที่จะเข้าใจ
ดังนั้นคุณอาจบอกว่านี่คือแฟล็ก
แต่ก่อนที่คุณจะเพิ่มความคิดเห็นนั้น คุณต้องบอกตัวเองว่า อืม บางทีรหัสของฉันอาจอ่านยาก
บางทีฉันควรเปลี่ยนตัวแปรเป็น cool เพื่อให้เข้าใจได้ง่ายขึ้น
นี่คือสิ่งที่คุณต้องปรับปรุงมากขึ้นเรื่อยๆ และคุณต้องการใช้ความคิดเห็นเป็นเครื่องมือพิเศษในการทำให้โค้ดของคุณเข้าใจได้
บางทีคุณอาจเขียนโค้ดว่าหกเดือนต่อจากนี้ คุณต้องการกลับไปทำความเข้าใจกับสิ่งที่คุณทำ
แต่อย่าลืมว่า ความคิดเห็นที่มากขึ้นไม่ได้แปลว่าโค้ดที่ดีกว่าเสมอไป
คุณต้องการกระชับและทำให้ทุกอย่างเรียบง่ายในขณะที่เพิ่มความคิดเห็นเฉพาะเมื่อจำเป็นเพื่อช่วยให้ผู้อื่นเข้าใจโค้ดของคุณ
ไม่ใช่พยายามทำให้โค้ดที่อ่านไม่ได้ของคุณอ่านง่ายขึ้น
เราจะสำรวจหัวข้อนี้และให้คำแนะนำตลอดหลักสูตร
แต่อย่าลืมว่าสิ่งสำคัญสำหรับนักพัฒนาซอฟต์แวร์หลักคนนี้ เพราะคุณต้องการมันตลอดอาชีพการงานของคุณ
อย่างไรก็ตาม บทความนี้มีประเด็นสำคัญบางประการที่ฉันคิดว่าคุณจะได้รับประโยชน์จากมัน โดยเฉพาะในแนวทางปฏิบัติที่ดีที่สุดสำหรับการแสดงความคิดเห็น
คุณสามารถอ่านสิ่งที่ควรทำและไม่ควรทำ และสิ่งที่โปรแกรมเมอร์ชั้นนำบางคนทำเมื่อแสดงความคิดเห็น
ฉันรู้ว่ามันฟังดูงี่เง่า แต่มันเป็นแนวคิดที่สำคัญที่หลักสูตรส่วนใหญ่มองข้าม ดังนั้นฉันขอแนะนำให้คุณอ่านเรื่องนี้
ฉันจะลิงก์ไปที่แหล่งข้อมูล แล้วพบกันใหม่ในวิดีโอหน้า