Phụ lục A của những giao dịch đặc tả ngôn ngữ C# với ý kiến tài liệu và nó khẳng định rằng có hai hình thức:bình luận Tài liệu trong C#: lý do kỹ thuật để thích là gì /// hoặc/**
single-line -doc-bình luận:
/// đầu vào-charactersopt
phân-doc-bình luận:
/** phân-comment-textopt */
là có một sở thích? Tôi nhận thấy một xu hướng thích định dạng single-line-doc-comment nhưng tôi không biết nếu có những lý do kỹ thuật hay thiết thực ngoài việc mọi người chọn từ quan điểm thẩm mỹ.
Tôi cũng đã đọc trong cuốn sách "C# cho nhà phát triển Java" của Jones và Freeman sau: ý kiến tài liệu
Mã đều bắt đầu bằng ba dấu gạch chéo, như ở đây:
/// A single line documentation comment.
Đặc tả C# cũng khuyên bạn nên sử dụng mã thông báo/** quen thuộc để xác định các nhận xét tài liệu nhiều dòng. Tuy nhiên phiên bản 7,00 của trình biên dịch C# không hỗ trợ cú pháp này.
Tôi không thể xác minh rằng các phiên bản mới nhất của csc không hoạt động với cú pháp đa dòng. Theo như tôi có thể nói cú pháp này hoạt động tốt.
**edit** Một số người đã yêu cầu hiển thị mẫu. Dưới đây là các mẫu:
/// <summary>
/// Performs a Method1 calculation on two strings
/// </summary>
/// <param name="arg1">The first string</param>
/// <param name="arg2">The second string</param>
/// <returns>The number 3</returns>
public static int Method1(String arg1, String arg2)
{
return 3;
}
/**
* <summary>
* Performs a Method2 calculation on two strings
* </summary>
* <param name="arg1">The first string</param>
* <param name="arg2">The second string</param>
* <returns>The number 3</returns>
*/
public static int Method2(String arg1, String arg2)
{
return 3;
}
Vậy câu hỏi, trình bày lại, là mẫu nào thích hợp hơn, là có kỹ thuật hoặc lý do khác để thích bình luận tài liệu phong cách của Method1 trong mẫu, trên, hoặc Method2 trong mẫu, ở trên?
Ba dấu gạch chéo được sử dụng để nhận xét một phương thức hoặc lớp và chú thích đó được sử dụng bởi intellisense để mô tả phương pháp. Tôi không nghĩ rằng bạn có thể làm tương tự với/** – paqogomez
phiên bản 7 là Visual Studio.NET 2002 hoặc 2003 (.net 1 và 1.1.x). – ps2goat
không có C# 7 - chúng tôi thậm chí không có bản phát hành C# 6 nào .... –