|
WritenEtiquette
A guide as to how we should format our code so when we or others come to edit it is presented in a uniform easy-to-understand way.
Featured, Phase-Implementation, Phase-Support Code Header/** * ====================================================== * Pure FM - http://www.purefm.com * ====================================================== * * Coders: Fred Bradley <sayhello@fredbradley.co.uk> * Elliot Lack <<insert chosen email address here>> * Shrey Puranik <<insert chosen email here>> * Christian Williams <<insert chosen email here>> * Dan Jones <<insert chosen email here>> * Maz Elsahhar <<insert chosen email here>> * * Date: May 2009 (or what ever the date actually is) * * Folder: <file path relative to the site's root> * File: <file name> * * ====================================================== * Feel free to use our code, but please always give * credit back to Pure FM with a link. * ====================================================== */ CommentingIn order for future tech team members to understand what we have done it's imperative that we comment our alterations, edits, and our fresh code in a descriptive manner. It's also important that we DateStamp our edits. And once gain, we should adhere to a template when doing this. 20090422 fredb: I had to change this blah blah blah... Keeping Code TidyWhen writing new code, please attempt to format your code so it's easy to read. In Dreamweaver this is easy. Commands -> Apply Source Formatting Those of you who write this gunk regularly now that properly formatted code will seriously help you out when you have to debug your code to solve a problem. If your tags aren't properly nested within another, then you'll find it very difficult to work out which <div> tag is closed where. |