Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What is the proper way of creating documentation in .NET (or general)?

Tags:

c#

.net

rider

I am just starting my professional career with software development and I got first project to get to know with it.

What very suprised me, was the fact ~30% of code are actually comments with

<param name="">
<summary> 

and so on. I think .NET devs know what I mean.

The point is, it is making this code very ugly. I understand it helps Swagger to make documentation, it helps IDE to describe methods and their params, but... it also makes code ugly.

Is it common practice? Or can it be done diffrent way?

BTW, I know it can be hidden in IDE, but this is not what I am asking about.

like image 932
Lucas Avatar asked Sep 17 '25 15:09

Lucas


1 Answers

Just to give you an example... check Microsoft Reference Source.

Documentation is necessary and it looks ugly to others if you don't do it. Understandable/maintainable code is good code for everyone.

You cannot go away from it and you must not.

like image 63
Derviş Kayımbaşıoğlu Avatar answered Sep 19 '25 05:09

Derviş Kayımbaşıoğlu