Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • World
  • Users
  • Groups
Skins
  • Light
  • Cerulean
  • Cosmo
  • Flatly
  • Journal
  • Litera
  • Lumen
  • Lux
  • Materia
  • Minty
  • Morph
  • Pulse
  • Sandstone
  • Simplex
  • Sketchy
  • Spacelab
  • United
  • Yeti
  • Zephyr
  • Dark
  • Cyborg
  • Darkly
  • Quartz
  • Slate
  • Solar
  • Superhero
  • Vapor

  • Default (No Skin)
  • No Skin
Collapse
Code Project
  1. Home
  2. General Programming
  3. .NET (Core and Framework)
  4. NDoc for .NET v.2.0

NDoc for .NET v.2.0

Scheduled Pinned Locked Moved .NET (Core and Framework)
csharpannouncementcollaborationxml
3 Posts 2 Posters 0 Views 1 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • J Offline
    J Offline
    jjrdk
    wrote on last edited by
    #1

    I wasn't quite sure which forum this should go under, so I put it here. I, like many others I'm sure, use NDoc to create documentation for my code. This is one great product, but it has one slight drawback. It doesn't document v.2.0 code. The team is working on it. In the meanwhile I use this little workaround to make NDoc document my V.2.0 projects: Create a file named NDocGui.exe.config and place it in the NDoc folder (e.g. C:\Program Files\NDoc 1.3\bin\net\1.1). In this config file you just type: and now NDoc will process the v.2.0 projects. (Supported Runtime Version number should of course be changed to reflect the actual version on your system.) There is even more good news for VB.Net developers. XML documentation is now supported for v.2.0 projects. Just use ''' (instead of /// for C# projects). This also works with NDoc. jjrdk

    C 1 Reply Last reply
    0
    • J jjrdk

      I wasn't quite sure which forum this should go under, so I put it here. I, like many others I'm sure, use NDoc to create documentation for my code. This is one great product, but it has one slight drawback. It doesn't document v.2.0 code. The team is working on it. In the meanwhile I use this little workaround to make NDoc document my V.2.0 projects: Create a file named NDocGui.exe.config and place it in the NDoc folder (e.g. C:\Program Files\NDoc 1.3\bin\net\1.1). In this config file you just type: and now NDoc will process the v.2.0 projects. (Supported Runtime Version number should of course be changed to reflect the actual version on your system.) There is even more good news for VB.Net developers. XML documentation is now supported for v.2.0 projects. Just use ''' (instead of /// for C# projects). This also works with NDoc. jjrdk

      C Offline
      C Offline
      Colin Angus Mackay
      wrote on last edited by
      #2

      The XML didn't show up because the browser treated it like HTML, and since it wasn't the browser's renderer just ignored it. You have to remember to either click the "Ignore HTML tags" check box, or manually put in the < and > escape sequences manually.

      <configuration>
      <startup>
      <supportedRuntime version="v2.0.50215" />
      </startup>
      </configuration>


      My: Blog | Photos "Man who stand on hill with mouth open will wait long time for roast duck to drop in." -- Confucious

      J 1 Reply Last reply
      0
      • C Colin Angus Mackay

        The XML didn't show up because the browser treated it like HTML, and since it wasn't the browser's renderer just ignored it. You have to remember to either click the "Ignore HTML tags" check box, or manually put in the < and > escape sequences manually.

        <configuration>
        <startup>
        <supportedRuntime version="v2.0.50215" />
        </startup>
        </configuration>


        My: Blog | Photos "Man who stand on hill with mouth open will wait long time for roast duck to drop in." -- Confucious

        J Offline
        J Offline
        jjrdk
        wrote on last edited by
        #3

        D'oh. Thanks to Colin.

        1 Reply Last reply
        0
        Reply
        • Reply as topic
        Log in to reply
        • Oldest to Newest
        • Newest to Oldest
        • Most Votes


        • Login

        • Don't have an account? Register

        • Login or register to search.
        • First post
          Last post
        0
        • Categories
        • Recent
        • Tags
        • Popular
        • World
        • Users
        • Groups