Sign in to follow this  
Link Hogthrob

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

Recommended Posts

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!

Share this post


Link to post
Share on other sites

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

Share this post


Link to post
Share on other sites

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.

Share this post


Link to post
Share on other sites
This thread is quite old. Please consider starting a new thread rather than reviving this one.

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Sign in to follow this