To Squad: Add Xml comments to your SDK objects/functions

[Link Hogthrob]

This may not be the proper forum, but it is a request and it does deal with plugins, so here goes...

Visual Studio displays any XML comments you place before your classes, methods, etc. in object browser and intellisense.

Makes it much easier for plugin developers to see what your objects and functions are for.

Example:

/// <summary>

/// This method makes your ship explode.

/// <summary>

public void Boom()...

Would display as:

Your function specifics etc.

Summary:

This method makes your ship explode.

It takes a little more time to document your code, but would be beneficial to the rest of us.

Thank you!

[Majiir]

While we\'re at it, we could ask Squad to give us a more decipherable API. (It drives me nuts that there are interdependent public fields in most of the KSP classes.) In the meantime, I think building our own, well-documented API is the best solution. (Shameless pimping, I know.)

[N3X15]

I suspect they already have them and are just busy.

[Link Hogthrob]

This is the first iteration, hopefully we will see some cleanup in later releases.

But yeah its hard to figure out what works and what doesn\'t. I like your idea of a wrapper though. I will comment on that thread further.