Code Monkey home page Code Monkey logo

Comments (4)

cwensley avatar cwensley commented on July 2, 2024

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..

from eto.

hultqvist avatar hultqvist commented on July 2, 2024

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.

from eto.

cwensley avatar cwensley commented on July 2, 2024

Namespaces commented:

Eto
Eto.Drawing

Left to comment:

Eto.Forms (the big one)
Eto.IO

from eto.

cwensley avatar cwensley commented on July 2, 2024

Now complete

from eto.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.