xml-documentation

问题 I would like to reference an operator in a <see cref="..." /> XML documentation tag, but I can't seem to find any hints on how to do it. The MSDN article on this tag only shows a simple example referencing a method, but does not go over different types of members that can be referenced. In particular, I would like to reference an implicit conversion operator , but general rule for referencing operators will also be appreciated. Example Let's say we have a simple structure for which we define

问题 I would like to reference an operator in a <see cref="..." /> XML documentation tag, but I can't seem to find any hints on how to do it. The MSDN article on this tag only shows a simple example referencing a method, but does not go over different types of members that can be referenced. In particular, I would like to reference an implicit conversion operator , but general rule for referencing operators will also be appreciated. Example Let's say we have a simple structure for which we define

问题 I'm having trouble figuring out why my code isn't recognizing the tagname "HourlySchedule". When it gets to: For Each HourlySchedule In Resp.getElementsByTagName("HourlySchedule") , it will skip to the end instead of looping thru each tag. I've tried several different tag names and it doesn't seem to work. Any suggestions? My VBA code: Sub Button1_Click() Dim URL As String: URL = "webaddress here" Dim mfile As String mfile = "<?xml version=" & """" & "1.0" & """" & "?><Envelope xmlns=" & """"

问题 I'm having trouble figuring out why my code isn't recognizing the tagname "HourlySchedule". When it gets to: For Each HourlySchedule In Resp.getElementsByTagName("HourlySchedule") , it will skip to the end instead of looping thru each tag. I've tried several different tag names and it doesn't seem to work. Any suggestions? My VBA code: Sub Button1_Click() Dim URL As String: URL = "webaddress here" Dim mfile As String mfile = "<?xml version=" & """" & "1.0" & """" & "?><Envelope xmlns=" & """"

问题 I have a number of interfaces in an assembly which I need to document using XML-Doc and Sandcastle. However, there are also a few interfaces I would like to ignore when building the documentation file. Right now I manage to do it by compiling the assembly with those interfaces marked as internal , but this is more a workaround than a solution to the problem since, in fact, those need to be public . Is there some kind of attribute one can decoracte unwanted ones with so that they are ignored?

问题 In my implementation I have this: /// <inheritdoc cref="IInterface{T} this[,]"/> public T this[long row, long column] { ... } The XMLdoc is already present in the IInterface . How can I pick it up from there (like I do for other things)? I get a compiler warning: Warning 108 XML comment on 'XXX.YYY.this[long, long]' has syntactically incorrect cref attribute 'IInterface this[,]' I tried removing the this from the cref but that didn't work either. What syntax do I need? 回答1: Use this: cref=

问题 I am trying generate XML comment for my asp.net website pages. But when i right click on the website in the solution explorer i can't find Properties instead i find Propert Pages . How to get started with xml documentation? Any suggestion. More specifically here: http://msdn.microsoft.com/en-us/library/azt1z1eh.aspx ("To build the XML Documentation sample within Visual Studio" section) I want to generate XML comments for my project in the build, but my "Configuration Properties" window does

问题 I have a rest api developed using ASP.NET WEB API. I used help pages nuget package in order to create documentation. One problem I encountered is the following. For my model objects, I have xml documentation comments and they become descriptions on the help pages for each member of the model. I want certain part of the description to be on a new line, but everything in the comment comes as one paragraph. I tried to add <br/> in the comments, but didn't help. Does anyone know how to achieve

问题 Is there a way to generate a readable document file from the documentation on the code directly from Visual Studio? (also considering 2010) Code example: /// <summary> /// Convert a number to string /// </summary> /// <param name="number">An integer number to be converted to string</param> /// <returns>Number as string</returns> /// <example> /// <code> /// var s = MyMethod(5); /// </code> /// </example> /// <exception cref="Exception">In case it can't convert</exception> /// <remarks> ///

问题 Sometimes I override methods in base classes. Sometimes I even override them with an empty method, because what I want is to prevent the behavior. In the past I would write something like this to show the intent of bypassing the base method : protected override void OnMouseUp(MouseEventArgs e) { // base.OnMouseUp(e); } (I know a commented line of code is a bad thing. I used to do it) But I want to do better: How do I document the intention of the override? specifically: What do I write in the