• 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

    • A lot of your issues seem to be part of all the smart tech that's in any current car today. I too don't like the reliance on any of this smart tech, we have 2024 Ford Rangers at work with terrible systems for climate control and media. And there have been times when, stupidly relying on the reversing camera more than the mirrors, that I nearly reversed into a wall, because the display was showing half a second lag, and it seems all the emergency breaking was lagging too. No impact, but I managed to stop with about 1cm clearance from the tow ball because I finally checked my mirrors. Too much beeping, too much reliance on the screen and a computer that's just going to fail after 8 years. This is the era of end of life cars, which fail because of end of support software updates rather than mechanical issues. Now if my 2010 Yaris was electric, that would be the ultimate electric vehicle. None of the smarts, all of the power!
    • Why is it all of the sudden throwing ads everywhere on WhatsApp when they've done it all along without any ads? Their parent company makes plenty of money. Not everything has to make money when the parent company is worth billions. They're just greedy. As far as YouTube, it's absurd to charge for a premium service when people just want to watch a few videos. Charge a reasonable amount for an ad-free experience unless they want to watch 4K movies like they do on Netflix. Back to WhatsApp, they've done it this whole time, so them forcing ads will make users use other platforms.
    • Yeh, an alert human driver would have stopped, or at least drastically slowed down BECASUE there was a red stop sigh and a flipping yellow school bus, which in the context of the USA means kids may be around, but even being from another country, even I know that's a school bus!! It will be difficult for autonomous vehicles to understand the nuances that each country, yet alone each state/province/town has. There's obviously the general rules, but contexts for particular elements of certain streets also help. It's partly why many people don't like "out of towners" as they aren't used to or know the roads, and while this may become possible down the track for autonomous vehicles eventually, it could end badly for some. Lets hope they don't say it's all in the name of progress..
    • lol. If you're referring to Co-pilot it can be UNINSTALLED!!!!! If you're referring to Recall its... 1) OPT-IN 2) CAN ALSO BE UNINSTALLED
  • Recent Achievements

    • First Post
      Ian_ earned a badge
      First Post
    • Explorer
      JaviAl went up a rank
      Explorer
    • Reacting Well
      Cole Multipass earned a badge
      Reacting Well
    • Reacting Well
      JLP earned a badge
      Reacting Well
    • Week One Done
      Rhydderch earned a badge
      Week One Done
  • Popular Contributors

    1. 1
      +primortal
      655
    2. 2
      ATLien_0
      275
    3. 3
      Michael Scrip
      222
    4. 4
      +FloatingFatMan
      187
    5. 5
      Steven P.
      146
  • Tell a friend

    Love Neowin? Tell a friend!