Click here to Skip to main content
15,887,988 members

Welcome to the Lounge

   

For discussing anything related to a software developer's life but is not for programming questions. Got a programming question?

The Lounge is rated Safe For Work. If you're about to post something inappropriate for a shared office environment, then don't post it. No ads, no abuse, and no programming questions. Trolling, (political, climate, religious or whatever) will result in your account being removed.

 
GeneralRe: Need free VS tool which generates code documentation for me! Pin
Graeme_Grant20-Feb-24 9:36
mvaGraeme_Grant20-Feb-24 9:36 
GeneralRe: Need free VS tool which generates code documentation for me! Pin
Jo_vb.net21-Feb-24 5:52
mvaJo_vb.net21-Feb-24 5:52 
GeneralRe: Need free VS tool which generates code documentation for me! Pin
Graeme_Grant21-Feb-24 8:51
mvaGraeme_Grant21-Feb-24 8:51 
GeneralRe: Need free VS tool which generates code documentation for me! Pin
Jo_vb.net21-Feb-24 12:31
mvaJo_vb.net21-Feb-24 12:31 
GeneralRe: Need free VS tool which generates code documentation for me! Pin
Peter Adam20-Feb-24 21:06
professionalPeter Adam20-Feb-24 21:06 
GeneralRe: Need free VS tool which generates code documentation for me! Pin
Davyd McColl20-Feb-24 23:49
Davyd McColl20-Feb-24 23:49 
GeneralRe: Need free VS tool which generates code documentation for me! Pin
trΓΈnderen21-Feb-24 1:51
trΓΈnderen21-Feb-24 1:51 
GeneralRe: Need free VS tool which generates code documentation for me! Pin
Davyd McColl21-Feb-24 3:21
Davyd McColl21-Feb-24 3:21 
and people wonder why, when there is documentation, a lot of the time, it completely sucks ):

fwiw, typing /// in Rider (and, I'd assume, in VS, using ReSharper) automatically inserts an xmldoc skeleton, like so:
C#
/// <summary>
/// 
/// </summary>
/// <param name="a"></param>
/// <param name="b"></param>
/// <returns></returns>
public int Add(int a, int b)
{
    return a + b;
}

so one could do the following, which I do in my personal library projects because I'd like there to be intellisense documentation, and some day I'll find a tool that generates a nice html site out of that xmldoc (there are some, but I haven't found one that is free and any good - I may have to resort to writing my own):
  1. enable xmldocumentation in the project
  2. update the csproj, as early as possible, with:
XML
<PropertyGroup>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
</PropertyGroup>

3. When creating a new method, or in response to build failure, do a triple-slash over the method and try to think of anything useful that could go in the summary. Sometimes it will be obvious, eg "Adds a and b and returns the result" - but I find that having to think about it, a lot of the time, there are useful summaries against my methods. I want full xmldoc for my users, but I agree there are times when the method seems quite obvious - so this is what I do there.

At least following the above instead of just running a tool invokes the random chance that your documentation is actually useful. Certifications that require documentation without any stipulation of usefulness seem like a complete waste of time:
- for the OP, certifiers and the users.
- OP has to run a tool or write some code.
- Certifiers have to check the output. Users have to use external code essentially blind - esp in an example like OPs where the actual intent is not at all obvious from the method name, at least not to a person who isn't "on the inside" with OP's terminology, and I'm 100% sure that a more useful doc string could be thought of there.

Running a tool to produce this useless documentation runs counter to the original intent of the certification too. If I were a certifier and saw that was what was going on, I'd fail the project /2c
------------------------------------------------
If you say that getting the money
is the most important thing
You will spend your life
completely wasting your time
You will be doing things
you don't like doing
In order to go on living
That is, to go on doing things
you don't like doing

Which is stupid.

GeneralRe: Need free VS tool which generates code documentation for me! Pin
Libiom21-Feb-24 6:38
Libiom21-Feb-24 6:38 
GeneralRe: Need free VS tool which generates code documentation for me! Pin
cplas21-Feb-24 7:51
cplas21-Feb-24 7:51 
GeneralRe: Need free VS tool which generates code documentation for me! Pin
Jo_vb.net21-Feb-24 7:54
mvaJo_vb.net21-Feb-24 7:54 
GeneralRe: Need free VS tool which generates code documentation for me! Pin
cplas21-Feb-24 7:55
cplas21-Feb-24 7:55 
GeneralRe: Need free VS tool which generates code documentation for me! Pin
Jo_vb.net22-Feb-24 11:57
mvaJo_vb.net22-Feb-24 11:57 
GeneralI was sent this, and... Pin
OriginalGriff19-Feb-24 21:48
mveOriginalGriff19-Feb-24 21:48 
GeneralRe: I was sent this, and... Pin
glennPattonWork319-Feb-24 21:49
professionalglennPattonWork319-Feb-24 21:49 
GeneralRe: I was sent this, and... Pin
Richard Deeming19-Feb-24 22:15
mveRichard Deeming19-Feb-24 22:15 
GeneralWordle 976 Pin
Shane010319-Feb-24 17:07
Shane010319-Feb-24 17:07 
GeneralRe: Wordle 976 Pin
Amarnath S19-Feb-24 17:18
professionalAmarnath S19-Feb-24 17:18 
GeneralRe: Wordle 976 Pin
GKP199219-Feb-24 17:55
professionalGKP199219-Feb-24 17:55 
GeneralRe: Wordle 976 - 5 4 me Pin
pkfox19-Feb-24 21:05
professionalpkfox19-Feb-24 21:05 
GeneralRe: Wordle 976 Pin
ChandraRam19-Feb-24 21:31
ChandraRam19-Feb-24 21:31 
GeneralRe: Wordle 976 Pin
OriginalGriff19-Feb-24 21:35
mveOriginalGriff19-Feb-24 21:35 
GeneralRe: Wordle 976 Pin
HobbyProggy20-Feb-24 0:02
professionalHobbyProggy20-Feb-24 0:02 
GeneralRe: Wordle 976 Pin
StarNamer@work20-Feb-24 4:56
professionalStarNamer@work20-Feb-24 4:56 
RantFor those of you with "medium" children.... beware the leftover pets PinPopular
charlieg19-Feb-24 15:50
charlieg19-Feb-24 15:50 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.