sandcastle

Consider that I have a complex class structure where many elements inherit from other elements. I may have a method GetStuff(string stuffName, int count) defined in an interface, which is inherited by other interface, which is then implemented abstractly by an abstract class, which is then implement explicit in a concrete class etc. etc... How should I handle inherited members such as GetStuff() when documenting my code with XML comments which will be used with a tool such as Doxygen or Sandcastle? It seems wrong to just copy and paste the same description at each level. Should I be

Is it possible to include custom attributes in Sandcastle documentation? For example, consider this c# method: public void ExampleMethod ( [Required] string input1, [DefaultValue("example")] string input2 ) Is there any way to make Sandcastle documentation output that input1 has the required attribute? This works for attributes and classes, I haven't tried it on properties and fields yet. The description suggests it should work. It might be required to turn on "Internal members" on too. Unfortunately the documented attributes are not linked. 来源： https://stackoverflow.com/questions/18586636/is

I am trying to generate website documentation for my C# code using the NuGet package of Sandcastle in Visual Studio (EWSoftware.SHFB). The fact is that I don't know how to use it. I install it from the NuGet package manager and then I have no idea what to do with it. I have no problem to edit my documentation project and to generate the corresponding website using the VS Sandcaslte extension installed with the default installer. Thank you for your help. Assuming that you already have a solution with a project, add a new project of type 'Documentation' to your solution. Right-click

Background I'm working on a small coding project that is going to be sold to other companies. I needed to create some documentation for it, so I decided to use Sandcastle. After taking far to long to download and install, I finally got it working, and noticed any public method or class that didn't have a comment had red text stating that the comment was missing. I then installed Ghostdoc to help speed up my commenting. This turned on the compiler warnings for missing xml comments, which was great because I now had a list of everything I needed to comment. The Problem One of my code files is an

When I run the Sandcastle Help File Builder project file (for example, myproject.shfbproj ) using Windows CMD, I get an annoying issue: $(SolutionDir) has the same value as $(ProjectDir) , and this means that project documentation sources won't build correctly, because I'm adding custom targets which already use $(SolutionDir) . If I build the whole Sandcastle Help File Builder from Visual Studio it builds successfully. I'm using the following command (executed from the directory where the project is stored): "C:\Program Files (x86)\MSBuild\14.0\Bin\MSBuild.exe" /p:Configuration=Development

How much code documentation in your .NET source is too much? Some background: I inherited a large codebase that I've talked about in some of the other questions I've posted here on SO. One of the "features" of this codebase is a God Class, a single static class with >3000 lines of code encompassing several dozen static methods. It's everything from Utilities.CalculateFYBasedOnMonth() to Utilities.GetSharePointUserInfo() to Utilities.IsUserIE6() . It's all good code that doesn't need to be rewritten , just refactored into an appropriate set of libraries. I have that planned out. Since these