ModEnc is currently in Maintenance Mode: Changes could occur at any given moment, without advance warning.

Difference between revisions of "Ini commenting"

From ModEnc
Jump to: navigation, search
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
If you are making a mod thn it is probly a good idea to comment it.
+
When making many [[ini]] files for a mod, you may find it worthwhile to comment them using a similar scheme to that laid out in many of the existing files. An example of such as laid out below.
  
  
== Author & Modtime & Modfiles & changes ==
+
== Author, Modtime, Modfiles, and Changes ==
This is my basic INI comment format-
+
<pre>
 
;============================================================================
 
;============================================================================
 
; (your ini file rules, art etc.).INI
 
; (your ini file rules, art etc.).INI
Line 13: Line 13:
 
; $Modfiles: $
 
; $Modfiles: $
 
; $changes: $
 
; $changes: $
;============================================================================
+
;============================================================================</pre>
  
 
"Author:" This is the persons name or screen name that made the mod.<br>
 
"Author:" This is the persons name or screen name that made the mod.<br>
Line 19: Line 19:
 
"Revisiontime:" The time you RE modded this file.<br>
 
"Revisiontime:" The time you RE modded this file.<br>
 
"Modfiles:" the files in your mod. (AKA-expandxx.mix, rules.ini, art.ini etc)<br>
 
"Modfiles:" the files in your mod. (AKA-expandxx.mix, rules.ini, art.ini etc)<br>
"changes:" Basic documtaion of what changes were made. (you can also say with file you put changes in<br>
+
"changes:" Basic documtaion of what changes were made. (you can also say with file you put changes in
if the list is to long.)<br>
+
if the list is to long.<br>)
 +
 
 +
This may be helpful if you mod over a long time and need to keep track of what you did.
  
This is helpful if you mod over a long time to keep track of what you did<br>
+
[[Category:Miscellaneous]]

Latest revision as of 06:18, 4 August 2005

When making many ini files for a mod, you may find it worthwhile to comment them using a similar scheme to that laid out in many of the existing files. An example of such as laid out below.


Author, Modtime, Modfiles, and Changes

;============================================================================
; (your ini file rules, art etc.).INI
;
;
; $Author: $
; $Modtime: $
; $Revisiontime:$
; $Modfiles: $
; $changes: $
;============================================================================

"Author:" This is the persons name or screen name that made the mod.
"Modtime:" The date the file was moded.
"Revisiontime:" The time you RE modded this file.
"Modfiles:" the files in your mod. (AKA-expandxx.mix, rules.ini, art.ini etc)
"changes:" Basic documtaion of what changes were made. (you can also say with file you put changes in if the list is to long.
)

This may be helpful if you mod over a long time and need to keep track of what you did.