• 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

    • thanks for that yeah its real its not fake guys i got it of amazon  how do i fix this please the good thing its not fake  
    • Oh Ok thank you,   i'll try to trace which one is the front fans and go from there, i forgot i posted on this issue before oopsy.        But they might already be connected right all i know lol.       I tend to worry way too much i think  
    • //merged your topics as they are the same thing. Same answer as well...    
    • Facebook's mobile app is finally getting support for passkeys by Usama Jawad Companies and social media platforms are embracing passkeys more readily nowadays. Microsoft made new accounts passwordless by default just last month, Windows 11 has supported passkeys for quite a while, and Google hasn't been left behind either. Interestingly, while passkeys work on WhatsApp too, Facebook hasn't enjoyed the same functionality, even though both apps are owned by the same parent company, Meta. Well, that changes today. Meta has announced support for passkeys in Facebook's mobile app. For those unaware, passkeys are essentially an alternative for passwords, as they allow you to sign in to a service securely using the same means that you use to unlock your device. This includes biometric authentication mechanisms such as facial and fingerprint recognition, as well as PIN. Since you don't need to memorize or externally store a complex password, and the methods highlighted above can't be easily duped, you effectively become more secure when you leverage passkeys. Passkeys were developed by the FIDO Alliance, and Meta is a member of this collective too. Apart from highlighting the benefits of passkeys, such as being pretty much immune to phishing and password spray attacks, Meta has revealed that they are coming to the Facebook mobile app on Android and iOS. They will also be arriving on Messenger in the next few months, and both services will share the same passkey for a more streamlined experience. Meta will also allow customers to utilize this passkey to securely autofill payment information when leveraging Meta Pay. Customers can head over to the Accounts Center in the Settings area to create and manage their passkey, or alternatively, they'll also be prompted to create one when they log in to Facebook next. It is important to note that Meta isn't doing away with passwords on Facebook just yet, as all devices may not be compatible with passkeys.
    • The fact it will show both "real" frames along with generated frames in the bar is amazing. Do we have confirmation if it works across all types - FSR, DLSS, DLSS MFG, XeFG?
  • Recent Achievements

    • First Post
      TIGOSS earned a badge
      First Post
    • Week One Done
      slackerzz earned a badge
      Week One Done
    • Week One Done
      vivetool earned a badge
      Week One Done
    • Reacting Well
      pnajbar earned a badge
      Reacting Well
    • Week One Done
      TBithoney earned a badge
      Week One Done
  • Popular Contributors

    1. 1
      +primortal
      681
    2. 2
      ATLien_0
      284
    3. 3
      Michael Scrip
      219
    4. 4
      +FloatingFatMan
      196
    5. 5
      Steven P.
      133
  • Tell a friend

    Love Neowin? Tell a friend!