Cách viết chú thích C++ hiển thị trong Intellisense?

Question

Tôi đang lập trình bằng C++ sử dụng Visual Studio 2010 Ultimate. Tôi muốn tài liệu một số chức năng và tôi muốn các tài liệu để hiển thị trong Intellisense.

Theo MSDN, tôi chỉ cần đặt nhận xét trước khi khai báo hoặc sau khi nhận xét trên cùng một dòng. Vì vậy, tôi đã thử điều này:

// This is a test. 
void foo(); 
void bar() { foo(); } 

Khi di chuyển chuột qua foo(), nhận xét không xuất hiện trong chú giải công cụ. Tôi cũng đã cố gắng:

• ///
• <summary></summary> thẻ
• Tòa nhà có /doc (bằng cách thiết lập "Tạo file XML tài liệu" tùy chọn trong các thiết lập dự án)

tôi đã không có may mắn cho đến nay. Có ai biết cách để thực hiện công việc này không?

Answer 1

Hãy thử cài đặt và sử dụng Visual Assistdoxigen phong cách:

/** 
* COMENT OF A CLASS 
**/ 
class Foo 
{ 
    public: 
     /** 
     * \brief A foo method. 
     * 
     * More complete description of foo. 
     * 
     * \param i A foo parameter. 
     * \return An int 
     * 
     **/ 
     int fooMethod(int i); 

    private: 
     int i; /*!< COMENT OF A MEMBER */ 

}; 

Answer 2

tại này được hỗ trợ trong VS 2012!

Trước đây, các thẻ XML trong các nhận xét chỉ được đọc bởi C++/CLI, không phải là C++ cũ. VS 2012 giờ đây mang lại ít nhất một số điều này vào C++ thông thường - nó nằm trong số What's New in Visual Studio 2012 và trong tài liệu MSDN: XML Documentation (Visual C++).

Tôi đã thử nghiệm ứng dụng này với ứng dụng của riêng mình vào cuối năm 2012 và tôi có thể xác nhận rằng các thẻ tóm tắt, para và seealso đều được lấy ra để định dạng chú giải công cụ.

Answer 3

Tôi chưa sử dụng VS2010 là quá nhiều năm để nhớ liệu điều này có hoạt động ở đó hay không. Nhưng những gì tôi đã làm trong nhiều năm qua trong nhiều phiên bản khác nhau của VS là ...:

#pragma region foo(float) 
/// <summary> .... </summary> 
/// <param name="bar"> .... </param> 
/// <returns> .... </returns> 
int foo(float bar) 
{ 
    // stuff 
} 
#pragma endregion 

Nói cách khác, bằng tay đưa vào chính xác những gì Visual Studio Automagically sẽ đưa vào cho C# mã cho bạn.

Sau đó cung cấp cho động cơ Intellisense một phút hoặc lâu hơn để hoàn nguyên tệp. Việc xây dựng sẽ buộc nó phải thô lỗ, tất nhiên.

Khi tôi nhớ lại, điều này hoạt động trong Cộng đồng Express gần đây nhất của VS2010, nhưng tôi không nhớ liệu nó có hoạt động trong VS2010 Ultimate hay không.

Answer 4

Tôi không chắc chắn phiên bản của Visual Studio giới thiệu đó nhưng trong VS 2015 bạn chỉ có thể đặt bình luận trên một function, method, class, struct, union, enum class, namespace hoặc thậm chí biến cá nhân (người dân địa phương quá) và nó sẽ được hiển thị bởi Intellisense. Nếu bạn muốn tài liệu gì đó từ một mô-đun khác, bạn phải viết nhận xét trong tệp tiêu đề. Ví dụ: