Calendar:Style Guide: Difference between revisions

no edit summary
No edit summary
Line 208: Line 208:
= C++ =
= C++ =
TBD
TBD
= Build System / Makefiles =
* Use spaces instead of tabs, except where needed by make (i.e target rules)
* Do not align variable definitions using spaces, one space surrounding operators only.
<pre>
# Bad:
MODULE          = calbase
LIBRARY_NAME    = calbase_s
MODULE_NAME      = calBaseModule
FORCE_STATIC_LIB = 1
GRE_MODULE      = 1
# Good:
DEPTH = ../../..
topsrcdir = @top_srcdir@
srcdir = @srcdir@
VPATH = @srcdir@
</pre>
* When setting many values for a variable (i.e line exceeds 80 chars), split into multiple lines and append <code>$(NULL)</code>
<pre>
# Good:
CPPSRCS = calDateTime.cpp \
  calDuration.cpp \
  calPeriod.cpp \
  calICSService.cpp \
  calRecurrenceRule.cpp \
  calRecurrenceDate.cpp \
  calRecurrenceDateSet.cpp \
  $(NULL)
# Good:
REQUIRES = xpcom js xpconnect
# Bad:
EXTRA_SCRIPTS = calAlarmService.js calAlarmMonitor.js calAttachment.js calAttendee.js calCalendarManager.js calDateTimeFormatter.js calEvent.js
</pre>
264

edits