It seems really simple just say what it does but how do you go about commenting your code?
I kinda spread them all over the place in different ways
But I always run into stuff like
I have no idea what that means but by my use of caps its important probably
So I really want to know, what is the "best way" to comment your code?
I kinda spread them all over the place in different ways
GML:
//This creates an array to hold the quick referance name for objects
_array_quick_obj_names = ["to.","db."];
var _array_quick_obj_names_length = array_length_1d(_array_quick_obj_names);
//This loops through the array checking to see if we typed the quick name in our input
for (var i = 0; i < _array_quick_obj_names_length; i++;)
{
var _obj_quickname_value = array_get(_array_quick_obj_names,i);
_quick_obj_name = string_pos(_obj_quickname_value,_quick_objname_input);
//checks to see if weve typed what were checking for and if so it saves it and stops the loop
if ((_quick_obj_name) != 0) //if the quick name is in the input string
{
if ((_quick_obj_name) = 1) //if the quick name is the first thing typed
{
var _quick_obj_name_found = _obj_quickname_value;
i = ( (_array_quick_obj_names_length) + 1 );
GML:
//WE NEED TO CONSTANTLY BE EDITING THIS
quick_input_tab = _value+" [";
So I really want to know, what is the "best way" to comment your code?