• 0

Does .NET have a Javadoc equivalent feature?


Question

15 answers to this question

Recommended Posts

  • 0

Yup, and it's a lot nicer.

you use "///" for your comments and use xml.

you will do something like:

/// <summary>
/// blah
/// </summary>
/// <remarks>
/// foo blah
/// </remarks>
/// <param name="bar">Does foo-bar</parm>
/// <returns>a bool, like <c>true</c></returns>
public bool IsThis42(int bar)
{
}

If you have the .Net Framework SDK Documenation look up "summary". It will tell you all the XML and how to compile it.

  • 0

you compile it with the "/doc" command.

The defined xml tags are:

c

code

param

para

see

seealso

example

paramref

summary

exception

permission

value

include

remarks

list

returns

The XML in the .Net is really nice. A lot better than Java. I should know I've worked w/ both really intensively.

  • 0

Nice... you know using the /doc command, it's not working, do i have to set my variable paths or whatever? :s... i only have VS.NET 2K3 installed and MSDN documentation, i'm assuming VS.NET 2K3 install will incorporate everything the SDK has itself as well right?

  • 0

That just creates an XML file that doesn't really look very nice. You could apply some sort of style sheet, but why bother when there's something to do it for you! NDoc - http://ndoc.sourceforge.net/wiki/HomePage is still in development, but I've used it to create some documentation and it works a treat! You can output to a JavaDoc style (like the Java API), MSDN style and various others! Makes everything look professional!

You have to document your code properly like pballsim says though. And I agree, it's a lot nicer than Java!

  • 0

It should generate an xml document so you should have: /doc:myclass.xml I don't think it will incorporate itself into the SDK (Java doesn't even do that very easily). I'm not sure how to actually use the xml document. I have a nice utility at work that does it for us.

This may help you (from the SDK)

  Quote
To set this compiler option in the Visual Studio development environment

Open the project's Property Pages dialog box. For details, see Setting Visual C# Project Properties.

Click the Configuration Properties folder.

Click the Build property page.

Modify the XML Documentation File property.

To set this compiler option programmatically

  • 0
  Winston said:
Nice... you know using the /doc command, it's not working, do i have to set my variable paths or whatever? :s... i only have VS.NET 2K3 installed and MSDN documentation, i'm assuming VS.NET 2K3 install will incorporate everything the SDK has itself as well right?

Get rid of the /doc property that you've added manually and do the following:

Goto 'Project' on the menu and click 'Project Properties' (project will be the name of you project). In that dialog, click 'Configuration Properties' in the left hand pane, and then 'Build'. Under 'Outputs' change the attribute 'XML Documentation File' to some filename e.g. doc.xml. Click OK and compile again. Should work for you this time.

This topic is now closed to further replies.
  • Recently Browsing   0 members

    • No registered users viewing this page.
  • Posts

    • I always just assumed that how I start programs is pretty close to how most people do it, which is... 1)Either start a program from desktop icon. or... 2)Windows key (or mouse click on start menu) and when start menu appears type in a little of what program you are trying to find, it will highlight, then press enter (or find it with mouse pointer and click it) is the very basic idea. this is very basic core functionality I would never change since it's quick and to the point and just works and has been this way a long time now. NOTE: I am on Linux Mint 22.1-Xfce, but the very basics like this are the same as Windows in this regard. I like how Mint tends to pretty much stay the same (minor tweaks from point release to point release that are slight but overall it's pretty much the same) instead of change for the sake of change like Windows does and ends up making some stuff potentially worse as a result. I say screw all of those trends where something has to 'look current' as I am more of the mindset once something looks good enough, which Mint does, you pretty don't screw with it as if someone does want to mess with it, they can do their own custom tweaks but the base install should be like that 'old faithful' type of interface that everyone has been familiar with for decades now. so by that standard the 'Start Menu' is still useful. I would NEVER get rid of that core functionality as Win8 pretty much tried that upon release and it made doing VERY basic stuff a chore which is why after I briefly tried Win8 in a VM, I never bothered with that OS again as that was easily Microsoft's biggest mess up with interface changes and I have been using Windows since v3.11 in mid-1990's and that Win8 interface change was by far the biggest mess up from Microsoft (how that made it to the final product is beyond me). I realize they supposedly fixed it in Win 8.1, but by then no one really cared as Win7 was the standard and those moving on from that went to Win10.
    • i click a few things on the start menu, other wise I do still use the run box daily.
    • That article title has a typo, it's supposed to say "Do I even need it?" And... I would not have wasted time writing a full article on a software [or feature] analysis based on exactly 1 user experience.
    • Lots of people use it without having an angsty Gotterdammerung.
    • Why certain models only? It should be provided on all high end phones.
  • Recent Achievements

    • Week One Done
      Wayne Robinson earned a badge
      Week One Done
    • One Month Later
      Karan Khanna earned a badge
      One Month Later
    • Week One Done
      Karan Khanna earned a badge
      Week One Done
    • First Post
      MikeK13 earned a badge
      First Post
    • Week One Done
      OHI Accounting earned a badge
      Week One Done
  • Popular Contributors

    1. 1
      +primortal
      679
    2. 2
      ATLien_0
      275
    3. 3
      Michael Scrip
      207
    4. 4
      +FloatingFatMan
      171
    5. 5
      Steven P.
      148
  • Tell a friend

    Love Neowin? Tell a friend!