Just a quick question.
I program in php and javascript alot but i have almost always coded alone so i've come across function comment headers like this one found in phpMyAdmin
/**
* Removes insecure parts in a path; used before include() or
* require() when a part of the path comes from an insecure source
* like a cookie or form.
*
* @param string The path to check
*
* @return string The secured path
*
* @access public
* @author Marc Delisle (lem9@users.sourceforge.net)
*/
Can some one tell me is there an editor that puts this in ?
Is it something like cvs or svn settings ?
Is it something that we put in ourselves ?
If it is something that we type in ourselves is these somewhere where this comment params and such are defined ?
Can anyone provide links for more reading for recommend file / function comment headers ?
I have recently started to understand svn and have set up my own svn / trac server. I also somewhat understand the basic check in / out stuff (although i have yet to actually do one). But i read some where that svn does add some comments itself but i didn't think it did all the function comments
anyway just trying to learn
thanks for any help
