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. The Lounge
  3. Need free VS tool which generates code documentation for me!

Need free VS tool which generates code documentation for me!

Scheduled Pinned Locked Moved The Lounge
visual-studio
37 Posts 18 Posters 1 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.
  • Graeme_GrantG Graeme_Grant

    Hmmm... Try this extension: Extended XML Doc Comments Provider (VS2022+) - Visual Studio Marketplace[^]

    Graeme


    "I fear not the man who has practiced ten thousand kicks one time, but I fear the man that has practiced one kick ten thousand times!" - Bruce Lee

    J Offline
    J Offline
    Jo_vb net
    wrote on last edited by
    #28

    Is installed now but I do not see a menu item or context menu item for starting it. What do I miss?

    Graeme_GrantG 1 Reply Last reply
    0
    • J Jo_vb net

      Can you please suggest me a free VS tool which generates code documentation like that:

          /// /// Called to calc a bid
          /// 
          /// 
          /// 
          /// iRatedBid\[player\]
          private int CalcBid(HandCards hand, int player)
      
      L Offline
      L Offline
      Libiom
      wrote on last edited by
      #29

      Atomineer is not free, but it's not expensive, either. It has a very high degree of customizability along with being very good at determining code function from element names. Documentation can be applied at various scopes, from a single element to an entire file, and limited to public members or applied to all. I have been using it for years and have been very pleased with it.

      1 Reply Last reply
      0
      • J Jo_vb net

        Can you please suggest me a free VS tool which generates code documentation like that:

            /// /// Called to calc a bid
            /// 
            /// 
            /// 
            /// iRatedBid\[player\]
            private int CalcBid(HandCards hand, int player)
        
        C Offline
        C Offline
        cplas
        wrote on last edited by
        #30

        In your VS project, type

        /

        three times and that comment will be generated, like so:

        /// /// 
        /// 
        /// 
        /// 
        private int ParseLevel(string text) {
        
        J 1 Reply Last reply
        0
        • C cplas

          In your VS project, type

          /

          three times and that comment will be generated, like so:

          /// /// 
          /// 
          /// 
          /// 
          private int ParseLevel(string text) {
          
          J Offline
          J Offline
          Jo_vb net
          wrote on last edited by
          #31

          Sure, this was already posted on Tuesday. The Lounge[^]

          C 1 Reply Last reply
          0
          • J Jo_vb net

            Sure, this was already posted on Tuesday. The Lounge[^]

            C Offline
            C Offline
            cplas
            wrote on last edited by
            #32

            Good to know 👍

            1 Reply Last reply
            0
            • J Jo_vb net

              Is installed now but I do not see a menu item or context menu item for starting it. What do I miss?

              Graeme_GrantG Offline
              Graeme_GrantG Offline
              Graeme_Grant
              wrote on last edited by
              #33

              Never used it myself, just looked good.

              Graeme


              "I fear not the man who has practiced ten thousand kicks one time, but I fear the man that has practiced one kick ten thousand times!" - Bruce Lee

              J 2 Replies Last reply
              0
              • Graeme_GrantG Graeme_Grant

                Never used it myself, just looked good.

                Graeme


                "I fear not the man who has practiced ten thousand kicks one time, but I fear the man that has practiced one kick ten thousand times!" - Bruce Lee

                J Offline
                J Offline
                Jo_vb net
                wrote on last edited by
                #34

                It is in project build properties and creates a xml file but only for already existing code comments. Walkthrough: Enabling and Using XML Comments[^]

                1 Reply Last reply
                0
                • T TNCaver

                  If those comments/methods are in a class library those comments could be very helpful to folks using that library.

                  There are no solutions, only trade-offs.
                     - Thomas Sowell

                  A day can really slip by when you're deliberately avoiding what you're supposed to do.
                     - Calvin (Bill Watterson, Calvin & Hobbes)

                  J Offline
                  J Offline
                  jochance
                  wrote on last edited by
                  #35

                  The crusade against comments wields a rusty pin and calls it a sword.

                  1 Reply Last reply
                  0
                  • Graeme_GrantG Graeme_Grant

                    Never used it myself, just looked good.

                    Graeme


                    "I fear not the man who has practiced ten thousand kicks one time, but I fear the man that has practiced one kick ten thousand times!" - Bruce Lee

                    J Offline
                    J Offline
                    Jo_vb net
                    wrote on last edited by
                    #36

                    Ok, my mistake. It seems to use IntelliSense and underlines methods names and when you move with the mouse over it, you get suggestions incl. return info!

                        /// /// Optimizes selection.
                        /// 
                        /// The find card.
                        /// The player ID.
                        /// The declarer ID.
                        /// The game status.
                        /// The s hand cards.
                        /// The trump ID.
                        /// The optimize mode.
                        /// The wnd.
                        /// The lead suit ID.
                        /// A bool
                    
                    1 Reply Last reply
                    0
                    • J Jo_vb net

                      Can you please suggest me a free VS tool which generates code documentation like that:

                          /// /// Called to calc a bid
                          /// 
                          /// 
                          /// 
                          /// iRatedBid\[player\]
                          private int CalcBid(HandCards hand, int player)
                      
                      J Offline
                      J Offline
                      Jo_vb net
                      wrote on last edited by
                      #37

                      Thanks to all for replying! Found this for commenting methods: CodeDocumentor - Visual Studio Marketplace[^] It appears when you move the mouse over the method name (with intelli sense)

                          /// /// Get hand trump cards.
                          /// 
                          /// The trump card ID.
                          /// \]\]>
                          public List GetHandTrumpCards(int TrumpCardID)
                      
                      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