Sự khác nhau giữa // và /// trong Visual Studio là gì?

Question

Stylecop đang yêu cầu tôi sử dụng /// thay vì // khi tôi đang nhận xét. Sự khác biệt ngữ nghĩa cho cả hai và khi nào tôi nên sử dụng cái nào?

Answer 1

// biểu ý kiến ​​cá nhân của riêng bạn, nơi /// biểu thị nhận xét có thể chứa dữ liệu đặc biệt, ví dụ đánh dấu để giải thích bằng Visual Studio - như:

/// <summary> 
/// This class does something. 
/// </summary> 
class Bob { 
    ... 
} 

Điều này sẽ cho Visual Studio biết tóm tắt về lớp Bob, và sau đó sẽ hiển thị trong hộp hoàn thành mã của bạn.

Answer 2

Tìm thấy bản thân mình trong khi đi qua thêm quy tắc StyleCop:

Sử dụng // khi commentin

Sử dụng /// khi tài liệu cho tiêu đề tài liệu XML

Answer 3

Các dấu gạch chéo ba cung cấp cho bạn một mẫu tự động tạo ra với các thông số và các tính năng khác tự động ở đó đợi em

/// <summary> 
/// Here is your comment 
/// </summary> 
/// <param name="sender">parameter generated automatically</param> 
/// <param name="e">as above</param> 
void BindableCollection_CollectionChanged(object sender, NotifyCollectionChangedEventArgs e) 

Cách tiếp cận này có nghĩa là một công cụ như NDoc sau đó có thể trawl nguồn của bạn để tạo ra tài liệu hướng dẫn tập tin cách tự động. Dấu gạch chéo kép chỉ không cắt nó ....

Answer 4

Không có sự khác biệt ngữ nghĩa, nó chỉ là một kiểu mã hóa hoặc nhận xét. .NET xảy ra để chọn cho ý kiến. Thông thường, hữu ích khi tuân theo các quy tắc này cho các công cụ tài liệu mã tự động như sandcastle.

Ví dụ Doxygen có kiểu nhận xét hoàn toàn khác cho mã C++. Vì vậy, nó chủ yếu là cho sự nhất quán và tiêu chuẩn