ทำไมงูหลามจึงไม่มีความคิดเห็นหลายบรรทัด?

ตกลงฉันทราบว่าสตริงสามใบเสนอราคาสามารถใช้เป็นความคิดเห็นแบบหลายบรรทัดได้ ตัวอย่างเช่น,

"""Hello, I am a 
   multiline comment"""

และ

'''Hello, I am a 
   multiline comment'''

แต่ในทางเทคนิคแล้วการพูดเหล่านี้เป็นสตริง

ฉันอ่านและอ่านคู่มือสไตล์ Python แต่ฉันไม่สามารถหาคำตอบทางเทคนิคได้ว่าทำไมไม่มีการใช้งานแบบหลายบรรทัดอย่างเป็นทางการ / * * / ประเภทความคิดเห็น ฉันไม่มีปัญหาในการใช้คำพูดสามคำ แต่ฉันอยากรู้อยากเห็นเล็กน้อยเกี่ยวกับสิ่งที่นำไปสู่การตัดสินใจออกแบบนี้

ฉันสงสัยว่าคุณจะได้คำตอบที่ดีกว่า "กุยโดไม่รู้สึกต้องการความคิดเห็นหลายบรรทัด"

Guido ได้ทวีตเกี่ยวกับสิ่งนี้:

เคล็ดลับหลาม: คุณสามารถใช้สตริงหลายบรรทัดเป็นความคิดเห็นแบบหลายบรรทัด นอกจากจะใช้เป็นเอกสารพวกเขาจะไม่สร้างรหัส! :-)

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

operation = ''
print("Pick an operation:  +-*/")
# Get user input here

ลองแสดงความคิดเห็นด้วยความคิดเห็นแบบหลายบรรทัด:

/*
operation = ''
print("Pick an operation:  +-*/")
# Get user input here
*/

โอ๊ะโอสตริงของคุณมีตัวคั่นความคิดเห็นท้ายสุด

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

จากการอ้างอิงของ Guido ความคิดเห็นหลายบรรทัดใน Python เป็นเพียงความคิดเห็นบรรทัดเดียวที่ต่อเนื่องกัน (ค้นหา "บล็อกความคิดเห็น")

หากต้องการแสดงความคิดเห็นบล็อกของรหัสบางครั้งฉันใช้รูปแบบต่อไปนี้:

if False:
    # A bunch of code

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

ทีนี้คำพูดสามคำถูกใช้เป็นความคิดเห็นหลายบรรทัดใน docstrings และมีการใช้ความคิดเห็น # รายการเป็นความคิดเห็นแบบอินไลน์และผู้ใช้ได้รับความคิดเห็น

ภาษาสคริปต์ส่วนใหญ่ไม่มีความคิดเห็นแบบหลายบรรทัดเช่นกัน อาจเป็นสาเหตุหรือไม่

ดูPEP 0008ส่วนความคิดเห็น

และดูว่าเครื่องมือแก้ไข Python ของคุณมีแป้นพิมพ์ลัดสำหรับบล็อกความคิดเห็นหรือไม่ Emacs รองรับเช่นเดียวกับ Eclipse สมมุติว่า IDEs ที่เหมาะสมส่วนใหญ่ทำ

จากThe Zen of Python :

ควรมีอย่างน้อยหนึ่งวิธีที่ชัดเจนกว่าที่จะทำ

ส่วนตัวสไตล์ความคิดเห็นของฉันในการพูด Java เป็นเหมือน

/*
 * My multi-line comment in Java
 */

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

#
# My multi-line comment in Python
#

VB.NET ยังเป็นภาษาที่มีความคิดเห็นเพียงบรรทัดเดียวและโดยส่วนตัวแล้วฉันพบว่ามันน่ารำคาญเพราะความคิดเห็นจบลงด้วยการดูน้อยชอบความคิดเห็นและอื่น ๆ อีกมากมายเช่นการเสนอราคา

'
' This is a VB.NET example
'

ความคิดเห็นแบบบรรทัดเดียวเท่านั้นจบลงด้วยการใช้อักขระน้อยกว่าความคิดเห็นแบบหลายบรรทัดและมีโอกาสน้อยที่จะถูกหลบหนีโดยตัวละครหลบในคำสั่ง regex บางที? ฉันมักจะเห็นด้วยกับเน็ดว่า

หากต้องการคอมเม้นต์บล็อกของโค้ดในPycharm IDE:

• รหัส | แสดงความคิดเห็นด้วย Line Comment
• Windows หรือ Linux: Ctrl+/
• Mac OS: Command+/

# This
# is
# a 
# multi-line
# comment

ใช้บล็อกความคิดเห็นหรือค้นหาและแทนที่ (s / ^ / # / g) ในโปรแกรมแก้ไขของคุณเพื่อให้ได้สิ่งนี้

ฉันแก้ไขได้โดยการดาวน์โหลดมาโครสำหรับโปรแกรมแก้ไขข้อความ (TextPad) ที่ให้ฉันสามารถเน้นเส้นแล้วใส่ # ที่บรรทัดแรกของแต่ละบรรทัด มาโครที่คล้ายกันจะลบ # ของ บางคนอาจถามว่าทำไม multiline จำเป็น แต่มีประโยชน์เมื่อคุณพยายามที่จะ "ปิด" บล็อกของรหัสสำหรับการแก้ไขจุดบกพร่อง

สำหรับคนอื่นที่กำลังมองหาความคิดเห็นหลายบรรทัดใน Python การใช้รูปแบบการเสนอราคาแบบสามคนสามารถมีผลที่เป็นปัญหาได้เนื่องจากฉันเพิ่งเรียนรู้วิธีที่ยากลำบาก พิจารณาสิ่งนี้:

this_dict = {
    'name': 'Bob',

"""
This is a multiline comment in the middle of a dictionary
"""

    'species': 'Cat'
}

ความคิดเห็นหลายบรรทัดจะถูกซ่อนไว้ในสตริงถัดไปทำให้'species'คีย์ยุ่งเหยิง ดีกว่าที่จะเพียงแค่ใช้#สำหรับความคิดเห็น

เนื่องจาก # อนุสัญญาเป็นเรื่องทั่วไปและไม่มีอะไรที่คุณสามารถทำได้ด้วยความคิดเห็นหลายบรรทัดที่คุณไม่สามารถทำได้ด้วยความคิดเห็น # -sign มันเป็นอุบัติเหตุทางประวัติศาสตร์เช่นบรรพบุรุษของ/* ... */ความคิดเห็นจะกลับไปที่ PL / I

สมมติว่าพวกเขาคิดว่าไม่จำเป็น เนื่องจากมันง่ายมากที่จะพิมพ์#a commentความคิดเห็นหลายบรรทัดอาจประกอบด้วยความคิดเห็นบรรทัดเดียวจำนวนมาก

สำหรับHTMLในทางกลับกันมีความจำเป็นสำหรับผู้ใช้หลายคน มันยากที่จะพิมพ์<!--comments like this-->ต่อไป

นี่เป็นเพียงการคาดเดา .. แต่

เนื่องจากเป็นสตริงจึงมีความหมายบางอย่าง (คอมไพเลอร์ไม่ได้กำจัดพวกเขา) ดังนั้นจึงเหมาะสมที่จะใช้เป็นเอกสาร จริง ๆ แล้วพวกเขากลายเป็นส่วนหนึ่งของASTดังนั้นการแยกเอกสารจะง่ายขึ้น

นอกจากนี้การแสดงความคิดเห็นหลายเป็นสุนัขตัวเมีย ขออภัยที่จะพูด แต่ไม่ว่าจะใช้ภาษาใดฉันจะไม่ใช้สิ่งเหล่านี้เพื่อจุดประสงค์ในการตรวจแก้จุดบกพร่อง สมมติว่าคุณมีรหัสเช่นนี้:

void someFunction()
{
    Something
    /*Some comments*/
    Something else
}

จากนั้นคุณจะพบว่ามีบางอย่างในรหัสของคุณที่คุณไม่สามารถแก้ไขได้ด้วยตัวดีบักดังนั้นคุณจึงเริ่มการดีบั๊กด้วยตนเองโดยการคอมเม้นต์โค้ดที่เล็กลงและเล็กลงด้วยการแสดงความคิดเห็นแบบหลายบรรทัด นี่จะทำให้ฟังก์ชัน:

void someFunction()
{ /*
    Something
   /* Comments */
   Something more*/
}

นี่มันน่ารำคาญจริงๆ

แสดงความคิดเห็นหลายบรรทัดโดยใช้IDLEบน:

• Mac OS Xหลังจากเลือกรหัสที่แสดงความคิดเห็นบล็อกของรหัสด้วยCtrl+ 3และ uncomment ใช้+Ctrl4

• ของ Windowsหลังจากเลือกรหัสที่แสดงความคิดเห็นบล็อกของรหัสที่มีCtrl+ Alt+ 3และ uncomment ใช้Ctrl+ +At4

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

x = '''
This is my
super-long mega-comment.
Wow there are a lot of lines
going on here!
'''

สิ่งนี้ใช้หน่วยความจำน้อย แต่มันให้ฟังก์ชั่นการแสดงความคิดเห็นหลายบรรทัดและผู้แก้ไขส่วนใหญ่จะเน้นไวยากรณ์ให้คุณ :)

นอกจากนี้ยังง่ายที่จะแสดงความคิดเห็นรหัสออกโดยเพียงแค่ห่อด้วย

x = '''

และ

'''