Commenting Code Standards

Commenting Code Standards

The following is an example of a code commenting standard we use, whetehrver applicable – and it doesn’t matter if it is to be used for HTML or scripting languages.

Comment indicator Start – FDG – Name – Date as MM-DD-YYYY Comment indicator
php, javascript, css
/*Start – FDG – Name – MM-DD-YYYY*/
smarty
{*Start – FDG – Name – MM-DD-YYYY*}
HTML

or in the case of HTML:

<!– FDG – Name – MM-DD-YYYY –>

 

Note – Not all code will always be commented, otherwise, before you know it – it would become bloated in of itself.

Want to discuss a project?

  • This field is for validation purposes and should be left unchanged.