บทนำ

ความคิดเห็นมีประโยชน์มากจริง ๆ ในการเขียนโปรแกรมหากมีการจัดวางที่ดี แต่ความคิดเห็นส่วนใหญ่มักไม่ค่อยดีนัก

ความคิดเห็นที่ไม่ดีอาจนำไปสู่ข้อมูลที่ผิด เสียเวลา สร้างนิสัยที่ไม่ดี ฯลฯ

ในบทความนี้ ผมจะแนะนำวิธีการหลีกเลี่ยงการเขียนความคิดเห็นที่ไม่ดี

ความคิดเห็นที่ไม่ดี

ความคิดเห็นที่ล้าสมัย

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

วิธีแก้:

• ปรับปรุงให้เร็วที่สุด
• เพียงแค่ลบมันจริง

ไวยากรณ์ไม่ถูกต้อง เครื่องหมายมากเกินไป พึมพำ พึมพำเป็นเพียงการเขียนที่ไม่ดี ตามแนวทางของ clean code ความคิดเห็นที่ควรค่าแก่การเขียนก็คุ้มค่าที่จะเขียนให้ดี หากคุณกำลังจะเขียน ให้ใช้เวลาในการขัดเกลาและเลือกคำอย่างระมัดระวัง

รหัสแสดงความคิดเห็น

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

มีวิธีแก้อย่างไร? แค่ลบทิ้ง ! ทุกวันนี้ Git มีค่ามาก เราสามารถหามันได้หากมีคนต้องการมันจริงๆ

ความคิดเห็นที่ซ้ำซ้อน

สิ่งเหล่านี้ก็แย่มากเช่นกัน ดูสิ่งนี้:

for(let i = 0; i < 10; i++){
  a = b // assign a to b
}

// a function returns sum of a and b
function sum(a, b){ return a + b}

เพียงแค่ลบพวกเขา

ความคิดเห็นที่มีเสียงดัง

ความคิดเห็นบางอย่างเป็นเพียงเสียงดัง คุณเคยเห็นความคิดเห็นเหล่านี้หรือไม่?

// the name
private String name
// the version
private String version
// the constructor
constructor()

//The 123213 License
//
//Copyright (c)123213213213213, and Contributors
//
//Permission to use, copy, modify, and/or distribute this software for any
//purpose with or without fee is hereby granted, provided that the above
//copyright notice and this permission notice appear in all copies.
//
//THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
//WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
//MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
//ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
//WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
//ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
//IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

ความคิดเห็น HTML

ไม่มีอะไรจะพูดเกี่ยวกับเรื่องนี้ ฉันไม่คิดว่าความคิดเห็น HTML มีประโยชน์เลย เรามี ID, ชื่อคลาส, ชื่อแท็ก และอีกหลายพันวิธีในการบอกความหมายของรหัส ทำไมต้องเขียนความคิดเห็นสำหรับพวกเขาอยู่แล้ว?

บทสรุป

แม้ว่าบางความเห็นจะมีความจำเป็นและเป็นประโยชน์ก็จริง แต่หลายๆ ความเห็นกลับไม่ใช่ ฉันรู้ว่าบทความนี้อาจไม่เป็นไปในเชิงบวก แต่ฉันแค่ต้องการพิสูจน์ว่า:

หากรหัสของคุณไม่ดี อย่าแสดงความคิดเห็น เพียงแค่ทำความสะอาด

ในบทความหน้าผมจะเขียนถึงวิธีการเขียนความคิดเห็นที่ดี โปรดกดปุ่มติดตามเพื่อตรวจสอบในอนาคต

ขอบคุณที่อ่าน

คำสุดท้าย

แม้ว่าเนื้อหาของฉันจะฟรีสำหรับทุกคน แต่ถ้าคุณพบว่าบทความนี้มีประโยชน์คุณสามารถซื้อกาแฟให้ฉันได้ที่นี่