Scripters: How do you usually give descriptions? (MV)

[Milena]

To the plugin makers or scripters for MV, you notice how small the box is for the description. How do you usually give a description to your plugin the smallest words possible, considering that your plugin may contain broad description or subject?

 

[Ramiro]

do you mean the:

/*: * @plugindesc This area with only two lines? * This can be used too... * This won't be shown... */Usually you just put a little description to remind you/people what's it.

for example "Cursor in title": "Display a customized cursor on the title screen"

If you need more to say, you may use the @help area... But IDK, sometimes the @plugindesc may not be needed, but it's kept even if it's obvious...

 

[Iavra]

"@plugindesc" usually contains just enough text to push my plugin id to the next line, so it's hidden in the editor


Regarding "@help", it's the same "How to Use" text i put in my plugin threads.

 

[Milena]

Yeah. I am writing this seemingly long plugin and I was thinking perhaps the person who'd probably use it might not want to read a long line of help file or documentation and just wants to use the plugin, might just look at the plugin description. Shorter words to describe what the plugin is all about, I guess.

 

[AwesomeCool]

Just tell what your plug-in is suppose to accomplish.  No need to tell the smaller details in the description box imo.

 

[Mellye]

What annoys me is that the Parameter description box isn't scrollable.

So many of my parameters end up with a "See HELP" in their descriptions.