Stack Overflow
Stack Overflow

Questions tagged [ndoc]

11 questions
37
votes
8 answers

What Are Best Practices For Documenting C# code with XML comments?

I'm going through some new code I just wrote and adding NDoc sytle comments to my classes and methods. I'm hoping to generate a pretty good MSDN style document for reference. In general, what are some good guidelines when writing comments for a…
Esteban Araya
  • 27,658
  • 22
  • 99
  • 139
36
votes
3 answers

.NET xml docs - inheriting documentation

NDoc has an XML element inheritdoc which allows you to inherit documentation of a member from the parent class (or an implemented interface). However, Visual Studio (i.e. the C# compiler) does not understand this tag and complains about the…
petr k.
  • 7,830
  • 6
  • 39
  • 52
12
votes
4 answers

Is SandCastle a dead project?

Microsoft killed NDoc when they released a CTP/Beta version of Sandcastle, and I rarely see information about new version of a usable version of sandcastle (with an integrated UI for example). The latest realease is the May 2008 release. Is…
PatriceVB
  • 973
  • 1
  • 9
  • 27
10
votes
2 answers

How can I link to MSDN/official documentation from my C# XML documentation comments?

Given an XML comment on a class something like this: ///Handles the AuthenticateRequest event in the ASP.NET page request lifecycle to authenticate users. /// ///This module will authenticate users based on cookies,…
Dylan Beattie
  • 50,029
  • 31
  • 120
  • 189
9
votes
1 answer

HelpInsight documentation in Delphi 2007

I am using D2007 and am trying to document my source code, using the HelpInsight feature (provided since D2005). I am mainly interested in getting the HelpInsight tool-tips working. From various Web-surfing and experimentation I have found the…
Andrew
  • 625
  • 5
  • 11
8
votes
14 answers

Code documentation: How much is too much?

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…
Robert S.
  • 24,673
  • 12
  • 81
  • 114
1
vote
0 answers

.Net Reflection Issue with Methods in NDoc Enhanced

I've used NDoc for quite a while now using a customised build (i.e. slightly bug-fixed build) of NDoc Enhanced (http://sourceforge.net/projects/ndoc-e/) but I've run into a strange issue with methods that have parameters which themselves take…
RobV
  • 26,016
  • 10
  • 71
  • 114
0
votes
1 answer

NDOC Error building documentation.

Using .NET Framework 3.5, I have nant -0.91-alpha2 which has support for framework 3.5 but I am getting the following error when I try to build the documentation. Error building Documentation. Object reference not set to an instance of…
RTN
  • 1
0
votes
1 answer

Documentation with NDOC3

I am working on a project documentation using NDOC3. The build fails when trying to document 3rd party DLLs (because I do not have the xml documentation for them). How could I address this issue ?
lkaw
  • 1
  • 1
0
votes
2 answers

Simplest way to add XML doc to a WinRT project

We have a group of developers moving from C++ to C# and WinRT. We used D'Oxygen as part of our C++ developer builds, and I'd like to continue to have document generation as part of the developer build in C#/WinRT. It's easy to turn on XML Doc…
Scott Smith
  • 3,401
  • 2
  • 28
  • 57
0
votes
3 answers

Ndoc on properties best practice?

My project manager last week hinted at using ndoc on properties within a class. Is this something that should be done? Is it considered best practice to do this or not? I am currently expanding all my ndoc for the section of a project that I am…
CSharpened
  • 9,906
  • 14
  • 47
  • 84