Embarrassingly Basic Question... T_T

Comments in the data files...

Guys,

 

              I'm messing around with .entity files and I've always found that comments help me to understand what I changed, why and what I intended to achieve by doing it.

 

Thing is, I cannot find out how to do so in SOASE .entity files... How do I tell the parser to ignore a little note I'm making in the file to myself and not to it? Can anyone let me know?

 

Iain

2,753 views 6 replies
Reply #1 Top

Commenting is something built into a language.  As there aren't any comments in any of the entity files, the function was likely never added into their system.

Reply #2 Top

the only way that most modders use is an ordinary text or rtf file with the changes listed in it or a copy of the original file with a different extension( the bit after the '.') eg entold entorg etc.

hope this helps

harpo

 

Reply #3 Top

You could do this as part of your develop/deploy process by developing a small process that strips lines that start with your preferred comment block and generates a clean entity file for testing in Sins. A little work on your part but if it's important to you it wouldn't be difficult to create.

I already prefer already to develop in a directory outside of the mod folder that is tied to a source code repository tool and then use ant to deploy to the various mod directories I maintain (one for unit testing, and one for shared alpha testing currently). If I want to see what I changed I can do compares against the history stored in the source repository so comments haven't been a priority for me but it has crossed my mind. I more miss comments for putting TODO blocks in the code so I can be reminded I wanted to come back to something later. ;P

 

Reply #4 Top

Thanks for the help guys. I'm not doing a big enough job that I considered developing outside of the framework of the game - but if my ideas get any more grandiose I suppose I'll have to consider it.

Todo blocks and change histories are the two main things I was looking for. I'm used to having both a commenting feature and a source protection utility - but as this is strictly a hobby project, I don't have any of the stuff I used to use at work. ;)

Ah well. I'll just have to start either noting down what I've changed or else keeping a folder full of different revisions. :)

Reply #5 Top

Check out code.google.com for maintaining source history and eclipse as a development platform.

This thread has some info on eclipse (https://forums.sinsofasolarempire.com/380774) and a entity validation tool I have written if your interested (I use subversion feature to do the source code control). Even for a small project I find performing checkins at various milestones a good habit to maintain. I created a project called zombiesrus5 on code.google.com just for little side projects. I have another one for a larger mod I am working on.

 

 

Reply #6 Top

Thanks for that, I shall check it out.

Dragging me kicking and screaming into the light of organisation, huh? ;)

 

Thanks for all the help!