สารบัญ:

ฉันจะเพิ่มความคิดเห็นใน XML ใน Visual Studio ได้อย่างไร
ฉันจะเพิ่มความคิดเห็นใน XML ใน Visual Studio ได้อย่างไร

วีดีโอ: ฉันจะเพิ่มความคิดเห็นใน XML ใน Visual Studio ได้อย่างไร

วีดีโอ: ฉันจะเพิ่มความคิดเห็นใน XML ใน Visual Studio ได้อย่างไร
วีดีโอ: สิ่งที่ควรทำเมื่อติดตั้ง VScode สำหรับนักพัฒนาเว็บไซต์มือใหม่ 😎💯 2024, อาจ
Anonim

ในการแทรกความคิดเห็น XML สำหรับองค์ประกอบโค้ด

  1. พิมพ์ /// ใน C# หรือ ''' ใน Visual Basic .
  2. จากเมนูแก้ไข เลือก IntelliSense > ใส่ความคิดเห็น .
  3. จากคลิกขวาหรือเมนูบริบทบนหรือเหนือองค์ประกอบโค้ด ให้เลือก Snippet > ใส่ความคิดเห็น .

นอกจากนี้ ฉันจะเขียนความคิดเห็นในรูปแบบ XML ได้อย่างไร

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

อาจมีคนถามว่าฉันจะใส่ความคิดเห็นโค้ดใน C # ได้อย่างไร ถึง รหัส NS ความคิดเห็น , พิมพ์เครื่องหมายทับสองครั้งตามด้วย ความคิดเห็น . คุณสามารถใช้เทคนิคนี้เพื่อเพิ่ม a ความคิดเห็น ในบรรทัดของตัวเองหรือเพิ่ม a ความคิดเห็น หลังจาก รหัส ในบรรทัด บ่อยครั้งเมื่อคุณ รหัส คุณอาจต้องการ ความคิดเห็น ออกทั้งบล็อกของ รหัส งบ.

ประการที่สอง ความคิดเห็น XML ใน C # คืออะไร

หนึ่งในนั้นคือ XML เอกสาร ความคิดเห็น ,บางครั้งเรียกว่า ความคิดเห็น XML ซึ่งขึ้นต้นด้วยสแลชสามตัว - /// ความคิดเห็น XML สามารถใช้โดยคุณสมบัติ IntelliSense ของ Visual Studio และ VS Code เพื่อแสดงข้อมูลเกี่ยวกับประเภทหรือสมาชิก ข้อมูลนี้มาจากสิ่งที่คุณใส่ในเอกสารรหัสของคุณ

รหัสเอกสารทำอย่างไร?

แนวปฏิบัติที่ดีที่สุดในการเขียนเอกสาร:

  1. รวมไฟล์ README ที่มี
  2. อนุญาตให้ใช้ตัวติดตามปัญหาสำหรับผู้อื่น
  3. เขียนเอกสาร API
  4. เอกสารรหัสของคุณ
  5. ใช้แบบแผนการเข้ารหัส เช่น การจัดระเบียบไฟล์ ความคิดเห็น หลักการตั้งชื่อ แนวทางปฏิบัติในการเขียนโปรแกรม ฯลฯ
  6. รวมข้อมูลสำหรับผู้ร่วมให้ข้อมูล

แนะนำ: