2012-10-03 84 views
4

我只是想知道其中一種格式是我必須在函數中編寫註釋,以便在鼠標懸停在功能上時顯示它們。將鼠標懸停在Visual Studio 08中時的功能信息顯示

void myfunct(int a; char b, float c); 

This function just messes with the variables with no objetive 
but to show people from stackoverflow what I mean. 
Inputs-> a: does nothing 
     b: neither this one 
     c: nope 

所以,當我使用的功能在一個大proyect我不需要去尋找什麼是對或者什麼特異功能是該變量的含義

回答

1

你可能想看看this documentation

+0

不錯!非常感謝 –

+0

對不起,其實這是非常有用的建議,但它不適合我。我知道這是tus支持智能感知,但它不工作!也許我錯過了什麼? –

+0

我的探針是它甚至不生成XML文件! –

2

,如果你想想像C#或VB這樣的顯示參數和功能的描述,在MSVC中沒有這樣的事情,但是微軟有一個特殊的代碼註釋格式,可以用來生成幫助:

/// <summary> 
/// summary of variable, function, class or any thing else 
/// </summary> 
/// <remarks> 
/// detailed description of object 
/// </remarks> 
/// <param name="a">description of a</param> 
/// <param name="b">description of b</param> 
/// <param name="c">description of c</param> 
/// <returns>describe return value of function</returns> 

當您編譯您的代碼時,它將生成一個可用於生成幫助文檔的XML文檔。

+0

確實很有用! –

相關問題