ฉันสงสัยว่ามีวิธี (หวังว่าจะเป็นแป้นพิมพ์ลัด) ในการสร้างส่วนหัวฟังก์ชันสร้างอัตโนมัติในสตูดิโอภาพ
ตัวอย่าง:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
และมันจะกลายเป็นแบบนี้โดยอัตโนมัติ ...
'----------------------------------
'Pre:
'Post:
'Author:
'Date:
'Param1 (String):
'Param2 (Integer):
'Summary:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
คำตอบ:
สร้าง "เครื่องหมายแสดงความคิดเห็นสามรายการ"
ใน C # คือ ///
ซึ่งเป็นค่าเริ่มต้นคายออกมา:
/// <summary>
///
/// </summary>
/// <returns></returns>
GhostDoc !
คลิกขวาที่ฟังก์ชันเลือก "เอกสารนี้" และ
private bool FindTheFoo(int numberOfFoos)
กลายเป็น
/// <summary>
/// Finds the foo.
/// </summary>
/// <param name="numberOfFoos">The number of foos.</param>
/// <returns></returns>
private bool FindTheFoo(int numberOfFoos)
(ใช่มันถูกสร้างขึ้นโดยอัตโนมัติทั้งหมด)
รองรับ C #, VB.NET และ C / C ++ มันเป็นค่าเริ่มต้นต่อแมปไปCtrl+ +ShiftD
ข้อควรจำ: คุณควรเพิ่มข้อมูลนอกเหนือจากลายเซ็นวิธีการลงในเอกสารประกอบ อย่าหยุดเพียงแค่เอกสารที่สร้างขึ้นโดยอัตโนมัติ คุณค่าของเครื่องมือเช่นนี้คือสร้างเอกสารที่สามารถดึงออกมาจากลายเซ็นวิธีการโดยอัตโนมัติดังนั้นข้อมูลใด ๆ ที่คุณเพิ่มควรเป็นข้อมูลใหม่
ดังที่กล่าวมาโดยส่วนตัวแล้วฉันชอบเมื่อวิธีการเป็นเอกสารในตัวเองทั้งหมด แต่บางครั้งคุณจะมีมาตรฐานการเข้ารหัสที่กำหนดเอกสารภายนอกจากนั้นเครื่องมือเช่นนี้จะช่วยให้คุณประหยัดเวลาในการพิมพ์ได้มาก
///
เป็นทางลัดสำหรับรับบล็อกความคิดเห็นคำอธิบายวิธีการ แต่ต้องแน่ใจว่าคุณได้เขียนชื่อฟังก์ชันและลายเซ็นก่อนเพิ่ม ก่อนอื่นให้เขียนชื่อฟังก์ชันและลายเซ็น
จากนั้นเหนือชื่อฟังก์ชันเพียงพิมพ์ ///
และคุณจะได้รับโดยอัตโนมัติ
Visual Assist มีวิธีแก้ปัญหาที่ดีเช่นกันและมีค่าใช้จ่ายสูง
หลังจากปรับแต่งเพื่อสร้างความคิดเห็นแบบ doxygen แล้วการคลิกทั้งสองนี้จะก่อให้เกิด -
/**
* Method: FindTheFoo
* FullName: FindTheFoo
* Access: private
* Qualifier:
* @param int numberOfFoos
* @return bool
*/
private bool FindTheFoo(int numberOfFoos)
{
}
(ภายใต้การตั้งค่าเริ่มต้นจะแตกต่างกันเล็กน้อย)
แก้ไข: วิธีปรับแต่งข้อความ "วิธีการเอกสาร" อยู่ใน VassistX-> Visual Assist Options-> Suggestions เลือก "Edit VA Snippets", Language: C ++, Type: Refactoring จากนั้นไปที่ "Document Method" และกำหนดเอง ตัวอย่างข้างต้นสร้างขึ้นโดย:
โดยปกติ Visual Studio จะสร้างโดยอัตโนมัติหากคุณเพิ่มเครื่องหมายแสดงความคิดเห็นเดี่ยวสามตัวเหนือสิ่งที่คุณต้องการแสดงความคิดเห็น (วิธีการคลาส)
ใน C # ///นี้จะเป็น
หาก Visual Studio ไม่ทำเช่นนี้คุณสามารถเปิดใช้งานได้ในไฟล์
ตัวเลือก -> แก้ไขข้อความ -> C # -> ขั้นสูง
และตรวจสอบ
สร้างความคิดเห็นเอกสาร XML สำหรับ ///
ในภาพพื้นฐานหากคุณสร้างฟังก์ชัน / ย่อยของคุณก่อนจากนั้นในบรรทัดด้านบนคุณพิมพ์ 'สามครั้งมันจะสร้าง xml ที่เกี่ยวข้องโดยอัตโนมัติสำหรับเอกสารประกอบ นอกจากนี้ยังปรากฏขึ้นเมื่อคุณวางเมาส์เหนือใน Intellisense และเมื่อคุณใช้ฟังก์ชันนี้
คุณสามารถใช้ข้อมูลโค้ดเพื่อแทรกบรรทัดใดก็ได้ที่คุณต้องการ
นอกจากนี้หากคุณพิมพ์เครื่องหมายคำพูดเดี่ยวสามตัว ('' ') บนบรรทัดเหนือส่วนหัวของฟังก์ชันระบบจะแทรกเทมเพลตส่วนหัว XML ที่คุณสามารถกรอกได้
ข้อคิดเห็น XML เหล่านี้สามารถตีความได้โดยซอฟต์แวร์เอกสารประกอบและรวมอยู่ในเอาต์พุตการสร้างเป็นไฟล์ assembly.xml หากคุณเก็บไฟล์ XML นั้นไว้กับ DLL และอ้างอิง DLL นั้นในโปรเจ็กต์อื่นความคิดเห็นเหล่านั้นจะพร้อมใช้งานใน Intellisense
ฉันกำลังทำงานในโครงการโอเพนซอร์สชื่อ Todoc ซึ่งวิเคราะห์คำต่างๆเพื่อสร้างเอาต์พุตเอกสารที่เหมาะสมโดยอัตโนมัติเมื่อบันทึกไฟล์ เคารพความคิดเห็นที่มีอยู่และรวดเร็วและลื่นไหลจริงๆ