• 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

    • Save 15% on the Insta360 Link 2 4K Webcam, now available at the lowest price by Taras Buria Insta360 is known for its high-quality 360-cameras, but the company also offers high-end webcams for those who want to elevate their video calls or streaming. Right now, the Insta360 Link 2 4K webcam is available at a new all-time low price, saving you 15% off the standard MSRP. The Insta360 Link 2 is not your standard 4K webcam. This camera is mounted on a two-axis gimbal that physically pans and tilts to follow you as you move around the room. You can also set boundaries to prevent the camera from capturing certain areas and control it with gestures for a hands-free experience. The camera itself has a large 1/2" 4K sensor that captures more light and details with HDR and low-light mode support. A larger sensor also means a more natural bokeh effect. Built-in microphones support voice focus and voice suppression, and the camera can balance your voice with background music. Other features include additional modes, such as whiteboard mode, DeskView mode, portrait mode, and privacy mode. The latter tilts the camera down after 10 seconds of inactivity (you can also push it down manually). The Insta360 Link 2 is also remotely operated with a dedicated phone app, plus its desktop software lets you adjust features like background, filters, and more. Insta360 Link 2 4K Webcam - $169.99 | 15% off on Amazon US Insta360 Link 2 4K Webcam Tripod Bundle - $195 | 15% off on Amazon US This Amazon deal is US-specific and not available in other regions unless specified. If you don't like it or want to look at more options, check out the Amazon US deals page here. Get Prime (SNAP), Prime Video, Audible Plus or Kindle / Music Unlimited. Free for 30 days. As an Amazon Associate, we earn from qualifying purchases.
    • RIP Jonathan Joss aka John Redcorn https://www.nbcnews.com/news/us-news/jonathan-joss-king-hill-voice-actor-killed-san-antonio-shooting-rcna210437
    • This will happen regardless what simply because people are upgrading their gear.
    • Rest in Peace, Loretta.  😢
    • Well, so did Lt. O'Reilly... but, we had to go there. 😂
  • Recent Achievements

    • Week One Done
      Nullun earned a badge
      Week One Done
    • First Post
      sultangris earned a badge
      First Post
    • Reacting Well
      sultangris earned a badge
      Reacting Well
    • First Post
      ClarkB earned a badge
      First Post
    • Week One Done
      Epaminombas earned a badge
      Week One Done
  • Popular Contributors

    1. 1
      +primortal
      160
    2. 2
      ATLien_0
      124
    3. 3
      Xenon
      120
    4. 4
      snowy owl
      109
    5. 5
      +Edouard
      97
  • Tell a friend

    Love Neowin? Tell a friend!