CodeIgniter Forums
How to maintain end of file comment? - Printable Version

+- CodeIgniter Forums (https://forum.codeigniter.com)
+-- Forum: Archived Discussions (https://forum.codeigniter.com/forumdisplay.php?fid=20)
+--- Forum: Archived General Discussion (https://forum.codeigniter.com/forumdisplay.php?fid=21)
+--- Thread: How to maintain end of file comment? (/showthread.php?tid=40829)



How to maintain end of file comment? - El Forum - 04-19-2011

[eluser]kenjis[/eluser]
Hi, guys!

CodeIgniter file must have a comment block to mark the end of file and it's location
according to http://ellislab.com/codeigniter/user-guide/general/styleguide.html#php_closing_tag

Like this:
Code:
/* End of file welcome.php */
/* Location: ./application/controllers/welcome.php */

I sometimes forget to update the comment.
How do you maintain the comment?


How to maintain end of file comment? - El Forum - 04-19-2011

[eluser]Eric Barnes[/eluser]
I personally have a "eof" tab trigger in my editor that does it automatically.

In textmate it is this snippet:
Code:
/* End of file $TM_FILENAME */
/* Location: `
filepath=$TM_FILEPATH
project=$TM_PROJECT_DIRECTORY
echo ${filepath/$project/.}
` */



How to maintain end of file comment? - El Forum - 04-20-2011

[eluser]CroNiX[/eluser]
Its also just good practice, not mandatory. CI, like any php app, will work just fine without any comments, even the ones in the footer.