Hmm. Nice thought at the move towards standardization... but I think scripts vary so dramatically that such a standard is impossible to satisfy both large scripts and small scriptlets, let alone combinations of these.
Another problem is when you put all this in one location, it because that much easier to rip (not include) or modify in redistribution. I'm quite happy with the many nonstandard current methods that scripters use in embedding comments in various places through out script files, just as long as they include SOME documentation. For those scripters who currently do not, this wont break their bad habits.
Suggestions like this have also been made in the past. Once I tried outfitting all of my script files with a version identifier that could [almost] be enumerated through with this single alias in each file.
ALIAS ScriptInfo {
; Gets the script's current load position. Something $script(filename) should do.
var %i = 1 | WHILE $script(%i) { if ($script == $ifmatch) { break } | inc %i }
if ($1 isnum) && ($1 != %i) {
return $ScriptInfo($1-)
}
elseif ($1- != $script) {
return $ScriptInfo($1-)
}
if ($prop == name) return Jupe Script
if ($prop == version) return 1.0
if ($prop == author) return Raccoon
if ($prop == longname) return Jupe Script v1.0 By Raccoon
if ($prop == desc) return Holds onto your nickname.
if ($prop == instructions) return /Jupe [On|Off] [[-]Nickname(s)]
if ($prop == file) return $script
if ($prop == order) return %i
}
It use to work somewhat well when recursion was not at all possible, because it would [almost] keep on calling the next $ScriptInfo identifier available in the next script file, until it finally hit the right one. It would be nice if this really would work someday, but it's not of any significant importance.
- Raccoon