-
Task
-
Resolution: Done
-
Normal
-
Sea Grant 2.0 beta 2
-
None
Code Cleanup before the release of Sea Grant 2.0 beta 2 (June 30, 2014).
http://code.tutsplus.com/tutorials/top-15-best-practices-for-writing-super-readable-code--net-8118
Code Guidelines (from Bootstrap guidelines):
HTML
- Two spaces for indentation, never tabs.
- Double quotes only, never single quotes.
- Always use proper indentation.
- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags).
- Use CDNs and HTTPS for third-party JS when possible.
- Use WAI-ARIA attributes in documentation examples to promote accessibility.
CSS
- Adhere to CSS Property Order --> http://markdotto.com/2011/11/29/css-property-order/
- Always a space after a property's colon (e.g., display: block; and not display:block
.
- End all lines with a semi-colon.
- For multiple, comma-separated selectors, place each selector on its own line.
- Don't add vendor prefixed properties to their unprefixed counterparts (e.g., only box-sizing and not also include -webkit-box-sizing), as this is done automagically at build time.
Indention style (Style 2, check link above):
function foo()
{
if ($maybe)
else
{ abort_mission(); } finalize();
}
Naming scheme:
Use camelCase