Site Maintenance and Style Guides

Introduction

This page lists information/tips/reminders for maintaining this website.

Programming Language Lists

If a programming language is added to the cheat sheets, update these pages in this order: cheatsheets.js Search Programming Language Cheat Sheets The Universal Function Library Project [feature recommendations] Online Compilers Timeline of New Features - Programming Language Comparison Documentation Links - Programming Language Cheat Sheets

Dates

What's New? Remember to add a 'year' header for each year. JEE.js Remember to keep the date up-to-date.

Cheat Sheets: Variable Names

Variables names are typically of the form vValue and oObj. Note: 'v' for values, don't use 'b'/'f'/'n'/'i'/'s' for bools/floats/numbers/ints/strings. This convention is uncommon, but aids readability/maintainability. It also avoids name collisions with built-in constants, with variable names typically working in all programming languages. For Excel and SQL variants, use 'My' instead of of 'v'/'o' For Excel, sometimes use 'A1' for key variables (e.g. instead of 'MyText'). For SQL variants, sometimes use 'MyCol' for key variables (e.g. instead of 'MyText'). Remember that PHP variables need the '$' prefix. Some generic return value variable names: vRet (return), vBool, vTextNew, oArrayNew. Further variable names: vPfx/vIfx/vSfx: for prefix/infix/suffix.

Cheat Sheets: Further

For the dates page, there are additional rows: 'JavaScript (Temporal)'.

WYSIWYG

Ideally, the text version of the website, i.e. copied and pasted into Notepad, should be fairly readable. I.e. in particular, the number of blank lines between items. See '[FIX]' on the What's New? page for potential issues affecting website layout.

Backwards Compatibility

At present, all code on the website is permitted to use the latest JavaScript. The exception is JEE.js, the functions should be compatible with Internet Explorer 11, so that they can be used with HTMLFile objects in Windows. JEE.js E.g. some nested loop text manipulations are faster using JavaScript in an HTMLFile object, than using native AutoHotkey code.