Create account / Log in

Add Comment Fields to Components

Suggestions for additional features for the module editor and Vassal engine.

Moderators: uckelman, Tim M

Add Comment Fields to Components

Postby pawnpusher » January 20th, 2021, 4:06 pm

It would be nice to have a comment field in every component, so a module designer could record notes about the component to aid in module building and maintenance.

When I learned programming in school, BASIC in high school and FORTRAN IV in college, I was encouraged to add copious comments in the code. I developed the habit of writing out a step by step description of intended program flow in the form of multiple comments before writing any code. Then for each comment I wrote the applicable code. It made writing code and debugging so much easier.

My work took me away from writing much code, and I never became an "expert" in any of the code languages I have used. It seems that the style of programming has changed dramatically. It seems that once you know how the VASSAL components work together the intended "program flow" for a module is not too difficult to see without designer comments. However, there are things designers want to do that require work arounds which may be difficult for another person to "see" why it was done. I think embedding copious comments is still quite useful. The fourth reply to this thread: http://www.vassalengine.org/forum/viewtopic.php?f=6&t=12756 indicates this.

Besides module maintainers benefitting, people new to VASSAL might be able to more quickly understand how it works if a designer included his intentions in comments. Such a module would almost be like a reference manual with examples.
User avatar
pawnpusher
 
Posts: 39
Joined: October 5th, 2013, 4:04 am
Location: Texas

Re: Add Comment Fields to Components

Postby uckelman » January 20th, 2021, 8:21 pm

Comments will be better supported in V4.
User avatar
uckelman
Site Admin
 
Posts: 9242
Joined: December 10th, 2007, 9:48 am
Location: Durham, England

Re: Add Comment Fields to Components

Postby pawnpusher » January 20th, 2021, 9:23 pm

Thank you
User avatar
pawnpusher
 
Posts: 39
Joined: October 5th, 2013, 4:04 am
Location: Texas


Return to Feature Requests

Who is online

Users browsing this forum: No registered users and 1 guest