开发者

Documentation: the <param> shows up in method summary

开发者 https://www.devze.com 2023-01-11 17:13 出处:网络
So I have basically started documenting a class library I made, this ist开发者_运维问答he first time I\'m doing a serious documenting (usually only do the <summary>) since it needs more info abo

So I have basically started documenting a class library I made, this is t开发者_运维问答he first time I'm doing a serious documenting (usually only do the <summary>) since it needs more info about some of the parameters used.

When I write:

///<summary>Method description.</summary>
///<param name="parameterName">Description of the parameter</param>

it displays "Method description. Description of the parameter" when looking in the intellisens for that method, what I want is for it to only show the summary and when writing the parameters for that method show the description of the parameter.


I can only blame the lack of sleep, It appears I did this formatting for ALL but 1 method which had <summary><param></param></summary> and of-course I was looking at only that method when checking to see if everything was the way I wanted it. Stupid I know but I found the problem at last...

0

精彩评论

暂无评论...
验证码 换一张
取 消

关注公众号