• 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

    • Store should be a shrine of useful applications, vetted and verified. Easily sorted by publisher. Windows should start with not much installed and have things as options in the store. Not the wild west mess that it is. You could delete 95%+ of the crap on there and no one would notice. They need to add a better UI to the updates, it's awful right now.
    • Obsidian 1.9.2 brings breaking changes, UI improvements and several bug fixes by David Uzondu Obsidian 1.9.2 (Desktop) is now live, bringing some significant updates, especially if you have been using the Bases feature. If you're not familiar with Markdown, it's a simple way to write formatted text using a plain text editor; Obsidian is a free editor that lets you create and link notes using Markdown files stored right on your own computer. Obsidian is free to use, but if you support the project with a Catalyst license, you get access to early builds. Version 1.9.2 is in Early Access right now, so you'll need a Catalyst license to try it out This new version introduces some major breaking changes to Bases, so you'll want to pay attention here. The developers have overhauled the formula syntax and the .base file format itself. If you're using Obsidian Sync or sharing your vault across multiple devices, the team strongly recommends upgrading all your devices at the same time to dodge any annoying sync issues with files using different syntaxes. The new formula syntax in Bases is designed to be more flexible and easier to use, and it should feel familiar if you code in JavaScript. For instance, functions are now object-oriented; instead of writing contains(file.name, "Books"), you would now use file.name.contains("Booksou can also chain functions together, like property.split(' ').sort()[0].lower(). Other highlights include: Property names are no longer wrapped in backticks (`). Instead, to reference properties with spaces or special characters, the syntax is note["Property Name"] There is a new type system which provides greater control when writing formulas. New functions, such as link, date and list for converting a value to a different type. New file properties: file.path, file.links (a list of all internal links in this file), and file.tags (a list of all tags in this file, including frontmatter). Some functions have been replaced by comparison operators. For example, dateBefore(date1, date2) is now date1 < date2. Date modifications are now much simpler. Instead of dateModify(date, string), you can use date + string, for example, date("01/01/2025") + "1 year" For those wondering, the Bases feature was introduced back in Obsidian 1.9.0 as a way to turn notes into structured databases. You can learn more about the updated syntax here. Alongside these syntax changes, the .base file format has been updated for better extensibility, including a new properties section for configurations like displayName. There are some smaller improvements too, like Bases now showing the number of results in the current view and the operator dropdown for filters becoming searchable. Outside of Bases, the update brings fixes for the following: Tags view: Fixed "Show nested tags" showing the full tag name (e.g. #parent/child) File explorer: Fixed "Move folder to..." menu item not showing in context menu. Bases: Fixed view not closing after deleting the file. Bases: Fixed codeblock not rendering when "Indent with tabs" is enabled. On a related note, the creator of Markdown, John Gruber, recently shared his thoughts on rumors about Apple Notes potentially adding Markdown export. While he had reservations about Apple Notes becoming a full-blown Markdown editor, he seemed to think an export option would be useful. If the rumors are true, users will be able to easily export notes from Apple Notes and edit them in editors like Obsidian.
    • 1. DRM is the worst plague, I like my games clean. 2. Third party launchers are an overhead and annoyance.
  • Recent Achievements

    • First Post
      Uranus_enjoyer earned a badge
      First Post
    • Week One Done
      Uranus_enjoyer earned a badge
      Week One Done
    • Week One Done
      jfam earned a badge
      Week One Done
    • First Post
      survivor303 earned a badge
      First Post
    • Week One Done
      CHUNWEI earned a badge
      Week One Done
  • Popular Contributors

    1. 1
      +primortal
      430
    2. 2
      +FloatingFatMan
      239
    3. 3
      snowy owl
      212
    4. 4
      ATLien_0
      211
    5. 5
      Xenon
      157
  • Tell a friend

    Love Neowin? Tell a friend!