Thêm mô tả lớp học vào mã?

Question

Tôi đang hoàn thành một dự án mà tôi đã làm việc một thời gian và tôi chỉ đang thực hiện những bước cuối cùng.

Một điều tôi muốn làm là thêm mô tả lớp ở đầu mỗi tệp lớp (để giúp bản thân và các lập trình viên khác tìm ra những gì đang xảy ra). Suy nghĩ của tôi là chỉ sử dụng một loạt các '/' 'để cắt đứt một phần cho tôi để viết một số ghi chú, nhưng có lẽ có một cách tốt hơn? Có cách nào được xây dựng để làm điều này trong Visual Studio?

///////////////////////////////////////////////////// 
//             // 
// KillZombies.cs         // 
//             // 
// Description: This class contains blah blah blah // 
//             // 
///////////////////////////////////////////////////// 

Answer 1

Vâng, bạn nên sử dụng bình thường XML documentation:

/// <summary> 
/// Describe your class quickly here. 
/// </summary> 
/// <remarks> 
/// Add more details here. 
/// </remarks> 

Bằng cách đó nó sẽ hiển thị trong Intellisense, và nếu bạn xây dựng tài liệu hướng dẫn của bạn với Sandcastle/ndoc/Doxygen vv nó sẽ xuất hiện một cách thích hợp.

Nếu bạn nhập "///" vào dòng phía trên lớp học của mình, bạn sẽ thấy mẫu thích hợp để bắt đầu. Xem liên kết MSDN ở trên để biết thêm thông tin.

Answer 2

Sử dụng XML documentation comments:

/// <summary> 
/// This class performs an important function. 
/// </summary> 

Khi bạn gõ ba chém Visual Studio sẽ giúp bạn với phần còn lại.

Không sử dụng định dạng ASCII ưa thích vì khi bạn cấu trúc lại để thay đổi tên lớp bạn sẽ sử dụng định dạng lại tất cả các hộp của bạn để làm cho chúng xếp hàng độc đáo trở lại.

Answer 3

Nhận xét tài liệu XML được mô tả trong các câu trả lời ở trên là cách để tìm tài liệu về các lớp và phương pháp.

Nếu bạn cần thêm thông tin trong mỗi tệp cho văn bản không phải tài liệu, chẳng hạn như ngày tạo, tín dụng, tin nhắn bản quyền, v.v. bạn có thể thêm nó dưới dạng đoạn trích hoặc thêm vào mẫu Visual Studio thích hợp. VS có các biến đặc biệt cho các mẫu như $ tên người dùng $ và $ time $ có thể được sử dụng để tự động chèn các giá trị này mỗi lần bạn thêm một mục mới dựa trên mẫu của bạn.