• 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 value a game as a whole including graphics. But going backwards in terms of graphics with a game I'm not already invested in (as in something I played and loved in the past and still do) is off-putting. Its a very poor demo trailer if they didn't crank the settings to max that would be ridiculous. Different strokes for different folks i guess, i'm not into slop the trailer and likely game could have been far better, it doesn't it instead looks like it was made on a shoe string budget or with lack of experience. But that could also be down to trying to get it running on low budget/outdated hardware and sacrificing the top end.
    • > Our goal is to ensure that the App Store remains an outstanding opportunity for developers and a safe, trusted experience for our users. There are so many scam apps on the platform that it is hard to believe they are truly interested in having a safe, trusted experience for their users.
    • Google announces upgraded Gemini 2.5 Pro model with enhanced capabilities by Pradeep Viswanathan Google today announced an updated Gemini 2.5 model with several improvements that can be observed in popular AI benchmarks. Google particularly highlighted that the new Gemini 2.5 Preview 06-05 "Thinking" model performs better in coding, math, science, and reasoning. Last month, during Google I/O, Google released an updated version of the Gemini 2.5 Pro model with significant improvements. Today's update builds on the release of the previous month with further enhancements. In addition to benchmark improvements, based on user feedback, this updated Gemini 2.5 Pro model also comes with improved style and structure, which will result in creative and better-formatted responses for end users. You can find the benchmark comparison with other leading AI models below. As you can notice in the above table, this updated Gemini 2.5 Pro preview model is now SOTA (State-of-the-Art) in coding benchmarks like Aider Polyglot. It also scored SOTA performance on GPQA and Humanity’s Last Exam (HLE) benchmarks, which test math, science, knowledge, and reasoning capabilities. In real-world testing, this latest 2.5 Pro model scored 24 points better on LMArena, maintaining its lead, and a 35-point jump on WebDevArena at 1443. Developers can access this latest Gemini 2.5 Pro preview model through the Gemini API via Google AI Studio and Vertex AI. General consumers will be able to access this model via the Gemini app. Google also confirmed that the Gemini 2.5 Pro model will be generally available in a couple of weeks, allowing developers to start using it in production-ready enterprise-scale applications.
    • The Bromance is definitely over! 🤣🤣🤣
    • I have the chance to live where electricity comes only from dams.
  • Recent Achievements

    • Week One Done
      jbatch earned a badge
      Week One Done
    • First Post
      Yianis earned a badge
      First Post
    • Rookie
      GTRoberts went up a rank
      Rookie
    • First Post
      James courage Tabla earned a badge
      First Post
    • Reacting Well
      James courage Tabla earned a badge
      Reacting Well
  • Popular Contributors

    1. 1
      +primortal
      418
    2. 2
      +FloatingFatMan
      181
    3. 3
      snowy owl
      178
    4. 4
      ATLien_0
      174
    5. 5
      Xenon
      135
  • Tell a friend

    Love Neowin? Tell a friend!