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
CODE PROJECT For Those Who Code
  • Home
  • Articles
  • FAQ
Community
  1. Home
  2. General Programming
  3. Visual Basic
  4. Documentation design

Documentation design

Scheduled Pinned Locked Moved Visual Basic
questionhtmldesignhelp
4 Posts 3 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.
  • N Offline
    N Offline
    normanordas
    wrote on last edited by
    #1

    Hi Guys can you help me with this: 1. How can I create an on-the-fly documentation generation for my codes so that when i compile my application the documentation is written in an html file? 2. How can i create my own description of the method i defined in my class such that when i call this method a TOOLTIP will come out exposing the Description i wrote for that particular method. Just like the members of any class in any assembly. When you press period (.) the members will come out and a tooltip will be displayed categorically showing the signature, return type and purpose for this method. Tnx a lot!

    D 1 Reply Last reply
    0
    • N normanordas

      Hi Guys can you help me with this: 1. How can I create an on-the-fly documentation generation for my codes so that when i compile my application the documentation is written in an html file? 2. How can i create my own description of the method i defined in my class such that when i call this method a TOOLTIP will come out exposing the Description i wrote for that particular method. Just like the members of any class in any assembly. When you press period (.) the members will come out and a tooltip will be displayed categorically showing the signature, return type and purpose for this method. Tnx a lot!

      D Offline
      D Offline
      Dave Kreskowiak
      wrote on last edited by
      #2

      By default, the current version of VB.NET does not support this. You'll either have to write the .XML documentation file yourself or use a third party tool like the VBCommentor PowerToy, found here[^] at GotDotNet. RageInTheMachine9532

      A 1 Reply Last reply
      0
      • D Dave Kreskowiak

        By default, the current version of VB.NET does not support this. You'll either have to write the .XML documentation file yourself or use a third party tool like the VBCommentor PowerToy, found here[^] at GotDotNet. RageInTheMachine9532

        A Offline
        A Offline
        Anonymous
        wrote on last edited by
        #3

        The description i wrote didn't come out as part of tooltip when the intellisense was invoke. I installed VBCommenter 1.1.1 and activate the xml everytime i build my project under Options menu. I was able to add some comment/description thru the " ''' " but when i called the method its not coming out although it created an .xml file. Am i missing something maybe some sort of configuration so that it will come out once intellisense is invoke? Tnx!

        D 1 Reply Last reply
        0
        • A Anonymous

          The description i wrote didn't come out as part of tooltip when the intellisense was invoke. I installed VBCommenter 1.1.1 and activate the xml everytime i build my project under Options menu. I was able to add some comment/description thru the " ''' " but when i called the method its not coming out although it created an .xml file. Am i missing something maybe some sort of configuration so that it will come out once intellisense is invoke? Tnx!

          D Offline
          D Offline
          Dave Kreskowiak
          wrote on last edited by
          #4

          I've never used it myself, but after looking thru the Forums on the GotDotNet.com site under VBCommentor, it looks like your won't see anything in Intellisense until the .DLL that is built is referenced in another project. You won't see anything in the current project... RageInTheMachine9532

          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