2012-02-08 29 views
6

Đầu tiên nhận thấy điều này trong Notepad ++, trong đó // nhận xét và /// nhận xét được hiển thị bằng các màu khác nhau.
Doxygen tiết lộ thêm về điều đó, nhưng tôi không thuyết phục về hiệu quả của nó.
1. Tại sao mọi người sử dụng ba kiểu nhận xét cắt giảm khi dễ dàng nhập /**/? (Tôi có giải thích tốt hơn là hữu ích khi lồng các chú thích)
2. Để có thể sử dụng được, trình chỉnh sửa hỗ trợ chặn nhận xét cho dấu gạch chéo ba theo cách mà Visual Studio hỗ trợ Ctrl+k Ctrl+c cho đa bình luận?Ba dấu gạch chéo về phía trước để chặn nhận xét?

+0

Bạn đang sử dụng Doxygen? Đây là lý do tại sao Doxygen đề xuất '///' thay vì '/ * * /' cho tài liệu mã C++. – birryree

+0

Nó sẽ là '/ ** * /' cho tài liệu. –

+0

Ok, vì vậy, đó là tài liệu hướng dẫn. Tôi nghĩ rằng đó là một cách thay thế/tốt hơn để thực hiện nhận xét nhiều dòng. – Nav

Trả lời

15

Trong Visual Studio /// cho biết documentation không chỉ là nhận xét. Theo liên kết của bạn, lời giải thích là như nhau. Nó được sử dụng để tô điểm cho ý kiến ​​mà sẽ được định dạng đặc biệt qua soạn thảo của bạn hoặc một số công cụ khác như tài liệu cho một lớp học, phương pháp namespace vv

+1

Đây là Visual Studio ít hơn và C# cụ thể hơn. C++ trong Visual Studio rõ ràng có thể có '///' bình luận, nhưng chúng không có ý nghĩa đặc biệt, và doc-comment-viewer cũng sẽ hiển thị các chú thích '//' hoặc '/ * * /'. – ssube

+2

Tôi vẫn chưa hiểu. Tôi muốn nhận xét, ví dụ: một chức năng như vậy, khi chuột của tôi kết thúc, nhận xét của tôi sẽ hiển thị hoặc trong menu, khi bạn có thể chọn các hàm lớp. Làm thế nào để làm điều đó? –

+0

Hiện có bất kỳ lối tắt nào để ghi lại tài liệu không? Thật nhàm chán khi tạo 3 '/' mọi lúc. Ctrl + K tạo 2 '/', không phải là 3 .. – Arkady

4
  1. Chắc chắn, nó dễ dàng hơn để đạt cùng ba lần trọng hơn đánh hai riêng biệt phím.
  2. Không biết về các IDE khác, nhưng XCode4 hỗ trợ đoạn mã nơi bạn có thể nhập khá nhiều thứ. Trên Visual Studio, tôi sử dụng Visual Assist X, mang lại cho tôi điều tương tự. XCode4 Example, Visual AssistX example. Tôi phải giả định các IDE khác cung cấp chức năng tương tự.

Điều đó nói rằng, vâng tôi cũng đã gặp ba dấu gạch chéo và chúng thường được sử dụng để chỉ ra các nhận xét rằng hệ thống tự động hóa như doxygen sẽ chọn.

+1

Visual Assist X cũng có tùy chọn mở rộng-multiline-nhận xét, được sử dụng với đoạn mã làm cho các chú thích '/ ** * * /' hầu như không có tác dụng. – ssube

7

Tác giả có thể có ý định đưa tài liệu sau ///

Tại nơi tôi làm việc, chúng tôi sử dụng 3 kiểu khối doxygen Viết bình luận cho tài liệu vì thiếu các hướng dẫn phong cách mã hóa.

  1. ///
  2. //!
  3. /** */
Các vấn đề liên quan