search

picoe / Eto

Cross platform GUI framework for desktop and mobile applications in .NET
Other
3.67k stars 333 forks source link

Commenting #13

Closed cwensley closed 10 years ago

cwensley commented 13 years ago

Should provide descriptive comments for all (public facing) code

cwensley commented 13 years ago

Should I use something like monodoc to generate comments? Having markup-free code is quite nice, and it would be able to plug into monodoc and monodevelop. This wouldn't help with visual studio, though..

hultqvist commented 12 years ago

Please do use the VisualStudio style markup!

It really helps with knowing you have found the right method or adding to understanding the parameters. For example I saw an email discussion about the interpretation of Rectangle.Right, and Rectangle.InternalRight, both these would be perfect to have a one line popup explaining what it actually means rather than unknowingly having to look up external documentation.

That documentation will popup in both VisualStudio and MonoDevelop and is very helpful if written.

The comments for a single method can be over 10 lines but both IDE mentioned above does a nice job at visually folding it into a single line, so it won't interfere with one working on the code.

cwensley commented 12 years ago

Namespaces commented:

Eto
Eto.Drawing

Left to comment:

Eto.Forms (the big one)
Eto.IO
cwensley commented 10 years ago

Now complete