Tôi đã tự hỏi liệu có cách nào (hy vọng là phím tắt) để tạo tiêu đề chức năng tự động tạo trong studio trực quan không.
Thí dụ:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
Và nó sẽ tự động trở thành một thứ như thế này ...
'----------------------------------
'Pre:
'Post:
'Author:
'Date:
'Param1 (String):
'Param2 (Integer):
'Summary:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
Câu trả lời:
Tạo "ba điểm đánh dấu nhận xét duy nhất"
Trong C # nó ///
như mặc định xuất hiện:
/// <summary>
///
/// </summary>
/// <returns></returns>Dưới đây là một số mẹo về chỉnh sửa mẫu VS.
GhostDoc !
Nhấp chuột phải vào chức năng, chọn "Tài liệu này" và
private bool FindTheFoo(int numberOfFoos)
trở thành
/// <summary>
/// Finds the foo.
/// </summary>
/// <param name="numberOfFoos">The number of foos.</param>
/// <returns></returns>
private bool FindTheFoo(int numberOfFoos)
(vâng, tất cả đều được tạo tự động).
Nó hỗ trợ C #, VB.NET và C / C ++. Nó theo mặc định được ánh xạ tới Ctrl+ Shift+ D.
Hãy nhớ rằng: bạn nên thêm thông tin ngoài chữ ký phương pháp vào tài liệu. Không chỉ dừng lại với tài liệu được tạo tự động. Giá trị của một công cụ như thế này là nó tự động tạo ra tài liệu có thể được trích xuất từ chữ ký phương thức, vì vậy bất kỳ thông tin nào bạn thêm vào đều phải là thông tin mới .
Điều đó đang được nói, cá nhân tôi thích khi các phương thức hoàn toàn tự lập tài liệu, nhưng đôi khi bạn sẽ có các tiêu chuẩn mã hóa bắt buộc phải lập tài liệu bên ngoài, và khi đó, một công cụ như thế này sẽ giúp bạn tiết kiệm rất nhiều thao tác gõ braindead.
///
là lối tắt để nhận khối nhận xét Mô tả Phương pháp. Nhưng hãy chắc chắn rằng bạn đã viết tên hàm và chữ ký trước khi thêm nó. Đầu tiên hãy viết tên Hàm và chữ ký.
Sau đó, phía trên tên hàm chỉ cần gõ ///
và bạn sẽ nhận được nó tự động
Visual Assist cũng có một giải pháp hay và có giá thành cao.
Sau khi điều chỉnh nó để tạo ra các nhận xét kiểu doxygen, hai lần nhấp này sẽ tạo ra -
/**
* Method: FindTheFoo
* FullName: FindTheFoo
* Access: private
* Qualifier:
* @param int numberOfFoos
* @return bool
*/
private bool FindTheFoo(int numberOfFoos)
{
}
(Theo cài đặt mặc định, nó hơi khác một chút.)
Chỉnh sửa: Cách tùy chỉnh văn bản 'phương pháp tài liệu' nằm trong VassistX-> Tùy chọn hỗ trợ trực quan-> Đề xuất, chọn 'Chỉnh sửa đoạn mã VA', Ngôn ngữ: C ++, Loại: Cấu trúc lại, sau đó đi tới 'Phương pháp tài liệu' và tùy chỉnh. Ví dụ trên được tạo bởi:
Thông thường, Visual Studio tạo nó tự động nếu bạn thêm ba điểm đánh dấu nhận xét bên trên thứ bạn muốn nhận xét (phương thức, lớp).
Trong C # điều này sẽ là ///.
Nếu Visual Studio không thực hiện điều này, bạn có thể bật nó trong
Tùy chọn-> Trình soạn thảo văn bản-> C # -> Nâng cao
và kiểm tra
Tạo nhận xét tài liệu XML cho ///
Về cơ bản trực quan, nếu bạn tạo hàm / phụ của mình trước, sau đó ở dòng phía trên, bạn gõ 'ba lần, nó sẽ tự động tạo xml có liên quan để làm tài liệu. Điều này cũng hiển thị khi bạn di chuột qua intellisense và khi bạn đang sử dụng hàm.
Bạn có thể sử dụng các đoạn mã để chèn bất kỳ dòng nào bạn muốn.
Ngoài ra, nếu bạn nhập ba dấu ngoặc kép đơn ('' ') trên dòng phía trên tiêu đề hàm, nó sẽ chèn mẫu tiêu đề XML mà sau đó bạn có thể điền vào.
Các nhận xét XML này có thể được giải thích bằng phần mềm tài liệu và chúng được đưa vào đầu ra của bản dựng dưới dạng tệp assembly.xml. Nếu bạn giữ tệp XML đó với DLL và tham chiếu DLL đó trong một dự án khác, những nhận xét đó sẽ có sẵn trong intellisense.
Tôi đang làm việc trên một dự án mã nguồn mở có tên là Todoc phân tích các từ để tự động tạo ra tài liệu phù hợp khi lưu tệp. Nó tôn trọng các bình luận hiện có và thực sự nhanh chóng và trôi chảy.