> Just curious... > > Every instance of code documentation (i.e. comments at the head of CF > tags describing author, function, variables, etc.) I've seen has > 'filename' included. > > Any reason? Surely it's spurious, the filename being kind of obvious if > you've got to the stage of reading the file's contents. Very curious to > know if there's a rationale, some coding situation I've yet to encounter > that makes this bit of documentation useful, or if it's just convention > and more RSI ;-)
In a purely textual header? Probably not much of a need. However, there are tools such as Fusedocs where you write the header information in XML and can later use utilities to parse through your headers and auto-generate documentation. I find that extremely useful. But I would say you have a good point, though. If you've opened the file, you probably know what it's name is! Regards, Dave. ______________________________________________________________________ Signup for the Fusion Authority news alert and keep up with the latest news in ColdFusion and related topics. http://www.fusionauthority.com/signup.cfm FAQ: http://www.thenetprofits.co.uk/coldfusion/faq Archives: http://www.mail-archive.com/[email protected]/ Unsubscribe: http://www.houseoffusion.com/index.cfm?sidebar=lists
