Jump to content
Search In
  • More options...
Find results that contain...
Find results in...

Documentation


Guest
 Share

Recommended Posts

So I think one of the main reasons people don't like working in the source is because they're either afraid of messing around with things they don't understand or they simply don't understand what the specific parts of the code do. As such for my engine I'm working on extensive documentation detailing specific things like what modules contain what, coding standards, ways to optimise and of course visual basic tutorials.

The first piece of documentation is Modules where I explain what each module does and the kind of users that should be messing around with these modules. You can get it here: [https://www.dropbox….kj3/modules.rtf](https://www.dropbox.com/s/fepunshjadfekj3/modules.rtf)

The second piece is on Writing Good, Optimised Code. You can get it here: https://www.dropbox.com/s/cwfzhbh20md5e2p/writing%20good%20code.rtf

Basically I'm looking for feedback on clarity, size (is it too short, too long?) and any other improvements you might think are necessary.
Link to comment
Share on other sites

> Personally I think we need a list of most (or all) of the functions with an explanation of the parameters and what it is used for. Just something to possibly add to your to-do list.

It's on it. Just sort of at the bottom of it because I haven't finished all the functions yet (nowhere near!).
Link to comment
Share on other sites

Very good job! That's useful for me and I think this is also useful for others who want to learn more about VB ![;)](http://www.touchofdeathforums.com/community/public/style_emoticons/<#EMO_DIR#>/wink.png) Keep going! I'm waiting for your other works ![:)](http://www.touchofdeathforums.com/community/public/style_emoticons/<#EMO_DIR#>/smile.png)
Link to comment
Share on other sites

Next one is finished. This one is about writing good, optimised code along with some things to avoid and general tips:

https://www.dropbox.com/s/l2ut7gagyzfwqkl/optimisation.rtf
Link to comment
Share on other sites

Yeah that's the idea. Like I said, people are really turned off from trying to work with Eclipse properly because no one really explains how to use VB and they're probably scared of messing something up.
Link to comment
Share on other sites

> Next one is finished. This one is about writing good, optimised code along with some things to avoid and general tips:
>
> [https://www.dropbox….g good code.rtf](https://www.dropbox.com/s/cwfzhbh20md5e2p/writing%20good%20code.rtf)

The file no longer exists ![:(](http://www.touchofdeathforums.com/community/public/style_emoticons/<#EMO_DIR#>/sad.png)
Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share

×
×
  • Create New...