Need free VS tool which generates code documentation for me!

Jacquers

GhostDoc

Mike Hankey

Seems the community edition is free all others paid.

"Ten men in the country could buy the world and ten million can’t buy enough to eat." Will Rogers PartsBin an Electronics Part Organizer - Release Version 1.3.1 JaxCoder.com Latest Article: EventAggregator

Jo_vb net

Thank you. Looks good but does not catch my return value?

/// Gets the hand trump cards.
/// The trump card identifier.
/// ///     
/// 
public List GetHandTrumpCards(int TrumpCardID)
{
    var lopc = new List();

    foreach (PlayingCard card in Cards)
    {
        if ((int)card.CardType == TrumpCardID | (int)card.CardValue == 2 | (int)card.CardValue == 3)
        {
            lopc.Add(card);
        }
    }

    return lopc;
}

Jacquers

Check what config options it has.

Jo_vb net

Probably not an options thing. It just does not fill the return section. The GhostDoc Comment editor shows:

Quote:

public List GetHandTrumpCards( int TrumpCardID ) Parameters TrumpCardIDType: Int32 The trump card identifier. Return Value

Lost User

Have you tried the compiler option: /doc (Process Documentation Comments) (C/C++) | Microsoft Learn[^] ?

Jo_vb net

No I did not, because I was not aware of it. Thank will try it.

0x01AA

This is not code documentation, these are just unnecessary comments ;P :laugh:

Maximilien

this processes existing comments. it does not create the comments themselves.

CI/CD = Continuous Impediment/Continuous Despair

den2k88

Extremely necessary if you want your SPICE or ASPICE certification.

GCS/GE d--(d) s-/+ a C+++ U+++ P-- L+@ E-- W+++ N+ o+ K- w+++ O? M-- V? PS+ PE Y+ PGP t+ 5? X R+++ tv-- b+(+++) DI+++ D++ G e++ h--- r+++ y+++* Weapons extension: ma- k++ F+2 X The shortest horror story: On Error Resume Next

Lost User

Of course it does, it needs the comments to convert them to document format. Which is what the OP asked for in his question.

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)

Malte Klena

Sandcastle: SHFB

lmoelleb

The autogenerated comments will just tell you what you already see from the name and types. Documentation is for the things you can't see directly. Personally my preferce is not having the autogenerated comment, then you do not need to waste time finding out if it tells you anything or not.

Ravi Bhavnani

Doesn't triple clicking "/" in VS generate the comment block? /ravi

My new year resolution: 2048 x 1536 Home | Articles | My .NET bits | Freeware ravib(at)ravib(dot)com

trønderen

The return value is not uniquely named. A method may have several return statements, and the values may be expressions, possibly different expression for each of several returns. The tool could of course create a list of all return statements. The same that you can obtain by a string search. I am not sure how useful that would be.

Religious freedom is the freedom to say that two plus two make five.

Jo_vb net

Do you say it works only for return value;

trønderen

I took this to be a framework for filling in you more descriptive comments, such as Set of cards currently held by 'bidder' (I can imagine even more helpful explanations that this, especially if I knew more of the context.) Without any explanation, just formatting the method prototype in a different layout, is meaningless.

Religious freedom is the freedom to say that two plus two make five.

trønderen

I never used this tool, but OP presents an example where it doesn't catch his 'return lopc;', leaving only

/// ///
///

in the 'documentation'. I am one of those who likes to get out of here as soon as the job is done; I detest the 'single exit point' style that could increase the block nesting level by half a dozen or more. In other words: Some methods can have half a dozen or more return statements. You might want to have them all listed above the method prototype; I think it messes it up. With several exits, the reason for leading to that exit is frequently far more essential than the exit value - especially if it is in the class of 'success' or 'failure'! Seeing four 'return failure' and two 'return success' in the documentation is not really informative. Seeing 'return lopc' makes very little sense until you have studied the actual code, seeing how lopc is built, but then you hardly need the documentation telling that lopc is returned! If you use the template for filling in a brief explanation of what it takes to succeed, or in this case, what is the semantics of the subset of cards returned: Fine. I assume it applies to all the return statements, if there are several. Also, those insisting on 'single exit point' must refrain from coding any exception that might propagate out of the method. That would be an exit not through that 'single exit point', so trusting that you can catch everything immediately before your single 'return' is fooling yourself.

Religious freedom is the freedom to say that two plus two make five.

Graeme_Grant

I tend to do my comments by hand. In VS, if you type /// it usually does the framework for you, including params and return types. Here is a handy reference for the recommendations and also XML tags: Documentation comments - document APIs using /// comments - C# | Microsoft Learn[^]. The link also includes Tools that accept XML documentation input[^] for generating documentation.

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