Places/Coding Style - Revision history

Mak77 at 11:26, 24 February 2010

2010-02-24T11:26:35Z

← Older revision		Revision as of 11:26, 24 February 2010
Line 54:		Line 54:

	Constructors params are inited like this (notice order of inited params should be the same as they are defined in the class definition, otherwise GCC will warn)<br>		Constructors params are inited like this (notice order of inited params should be the same as they are defined in the class definition, otherwise GCC will warn)<br>
	<pre>nsNavHistory::Method(type1* aParam1,		<pre>
	const type2& aParam2)		nsNavHistory::Method(type1* aParam1,
			const type2& aParam2)
	: mProperty1(0)		: mProperty1(0)
	, mPRoperty2(PR_FALSE)		, mPRoperty2(PR_FALSE)
Line 61:		Line 62:
	impl;		impl;
	}		}
	</pre>		</pre>
	Use namespace mozilla::places where possible, or anonymous namespace for file scope.		Use namespace mozilla::places where possible, or anonymous namespace for file scope.

Mak77 at 11:25, 24 February 2010

2010-02-24T11:25:41Z

← Older revision		Revision as of 11:25, 24 February 2010
Line 54:		Line 54:

	Constructors params are inited like this (notice order of inited params should be the same as they are defined in the class definition, otherwise GCC will warn)<br>		Constructors params are inited like this (notice order of inited params should be the same as they are defined in the class definition, otherwise GCC will warn)<br>
	<pre>nsNavHistory::~~nsNavHistory~~()		<pre>nsNavHistory::Method(type1* aParam1,
	: ~~mBatchLevel~~(0)		const type2& aParam2)
	, ~~mBatchHasTransaction~~(PR_FALSE)		: mProperty1(0)
	~~, mCachedNow(0)~~		, mPRoperty2(PR_FALSE)
	~~, mExpireNowTimer(nsnull)~~
	~~, mExpireDaysMin(0)~~
	~~, mExpireDaysMax(0)~~
	~~, mExpireSites(0)~~
	~~, mNumVisitsForFrecency(10)~~
	~~, mTagsFolder(-1)~~
	~~, mInPrivateBrowsing(PRIVATEBROWSING_NOTINITED)~~
	~~, mDatabaseStatus(DATABASE_STATUS_OK)~~
	~~, mCanNotify(true)~~
	~~, mCacheObservers("history-observers"~~)
	{		{
	impl;		impl;

Mak77 at 14:03, 15 December 2009

2009-12-15T14:03:55Z

← Older revision		Revision as of 14:03, 15 December 2009
Line 1:		Line 1:
	As a general rule we follow conventions reported in the ~~global coding style page:~~ https://developer.mozilla.org/En/Developer_Guide/Coding_Style		As a general rule we follow conventions reported in the [https://developer.mozilla.org/En/Developer_Guide/Coding_Style Global Coding Style page].<br>

	With some differences:		With some differences:
Line 51:		Line 51:
	}		}
	</pre>		</pre>
	Notice that input params are always starting with "a" letter, while output params should be prefixed with ~~and~~ underscore.		Notice that input params are always starting with "a" letter, while output params should be prefixed with an underscore.

	Constructors params are inited like this (notice order of inited params should be the same as they are defined in the class definition, otherwise GCC will warn)<br>		Constructors params are inited like this (notice order of inited params should be the same as they are defined in the class definition, otherwise GCC will warn)<br>
Line 78:		Line 78:
	<br>		<br>

	If both Coding ~~style guide~~ and this page cannot answer your question regarding code style, try checking [http://mxr.mozilla.org/mozilla-central/source/storage/style.txt Storage code style document], we don't follow all Storage code style conventions, but it contains some interesting idea.<br>		If both [https://developer.mozilla.org/En/Developer_Guide/Coding_Style Globarl Coding Style page] and this page cannot answer your question regarding code style, try checking [http://mxr.mozilla.org/mozilla-central/source/storage/style.txt Storage code style document], we don't follow all Storage code style conventions, but it contains some interesting idea.<br>

Mak77 at 14:02, 15 December 2009

2009-12-15T14:02:03Z

← Older revision		Revision as of 14:02, 15 December 2009
Line 46:		Line 46:
	When defining cpp methods opening brace and type are in new lines:<br>		When defining cpp methods opening brace and type are in new lines:<br>
	<pre>type*		<pre>type*
	~~newMethod~~(type ~~param~~)		Class::NewMethod(type aParam, type* _outParam)
	{		{
	impl;		impl;
	}		}
	</pre>		</pre>
			Notice that input params are always starting with "a" letter, while output params should be prefixed with and underscore.

	Constructors params are inited like this (notice order of inited params should be the same as they are defined in the class definition, otherwise GCC will warn)<br>		Constructors params are inited like this (notice order of inited params should be the same as they are defined in the class definition, otherwise GCC will warn)<br>
	<pre>nsNavHistory::nsNavHistory()		<pre>nsNavHistory::nsNavHistory()

Mak77 at 14:00, 15 December 2009

2009-12-15T14:00:10Z

← Older revision		Revision as of 14:00, 15 December 2009
Line 42:		Line 42:
	NS_ENSURE_TRUE(annoSvc, NS_ERROR_OUT_OF_MEMORY);		NS_ENSURE_TRUE(annoSvc, NS_ERROR_OUT_OF_MEMORY);
	</pre>		</pre>
	To null check other pointers use NS_ENSURE_STATE(something);<br>		To null check other pointers use NS_ENSURE_STATE(something) unless it's a memory mapping issue.<br>

	When defining cpp methods opening brace and type are in new lines:<br>		When defining cpp methods opening brace and type are in new lines:<br>

Mak77 at 13:58, 15 December 2009

2009-12-15T13:58:58Z

← Older revision		Revision as of 13:58, 15 December 2009
Line 72:		Line 72:
	Use namespace mozilla::places where possible, or anonymous namespace for file scope.		Use namespace mozilla::places where possible, or anonymous namespace for file scope.

	Add Places or nsPlaces in front of components or modules names, so that they are easily recognizeable in components/modules folders and also to prevent naming conflicts.		Add Places or nsPlaces in front of components or modules names, so that they are easily recognizeable in components/modules folders and also to prevent naming conflicts.<br>

			<br>

			If both Coding style guide and this page cannot answer your question regarding code style, try checking [http://mxr.mozilla.org/mozilla-central/source/storage/style.txt Storage code style document], we don't follow all Storage code style conventions, but it contains some interesting idea.<br>

Mak77 at 13:55, 15 December 2009

2009-12-15T13:55:36Z

← Older revision		Revision as of 13:55, 15 December 2009
Line 22:		Line 22:
	catch(ex) {}		catch(ex) {}

	</pre>		</pre>
	Oneliners statements inside if/elseif/else conditions can avoid braces, but if any side of the condition uses braces then all sides will take them:<br>		Oneliners statements inside if/elseif/else conditions can avoid braces, but if any side of the condition uses braces then all sides will take them:<br>
	<pre>if (condition)		<pre>if (condition)
	statement;		statement;
Line 36:		Line 36:
	statement2;		statement2;
	}		}
	</pre>		</pre>
	When instantiating services in cpp use this form:<br>		When instantiating services in cpp use this form:<br>
	<pre>nsCOMPtr<nsIAnnotationService> annoSvc =		<pre>nsCOMPtr<nsIAnnotationService> annoSvc =
	do_GetService(NS_ANNOTATIONSERVICE_CONTRACTID);		do_GetService(NS_ANNOTATIONSERVICE_CONTRACTID);
	NS_ENSURE_TRUE(annoSvc, NS_ERROR_OUT_OF_MEMORY);		NS_ENSURE_TRUE(annoSvc, NS_ERROR_OUT_OF_MEMORY);
	</pre>		</pre>
	To null check other ~~objects~~ use NS_ENSURE_STATE(~~obj~~);<br>		To null check other pointers use NS_ENSURE_STATE(something);<br>

	When defining cpp methods opening brace ~~goes~~ in new ~~line~~:<br>		When defining cpp methods opening brace and type are in new lines:<br>
	<pre>type*~~ ~~newMethod(type param)		<pre>type*
			newMethod(type param)
	{		{
	impl;		impl;
	}		}
	</pre>		</pre>
	Constructors params are inited like this (notice order of inited params should be the same as they are defined in the class definition, otherwise GCC will warn)<br>		Constructors params are inited like this (notice order of inited params should be the same as they are defined in the class definition, otherwise GCC will warn)<br>
	<pre>nsNavHistory::nsNavHistory()		<pre>nsNavHistory::nsNavHistory()
	: mBatchLevel(0)		: mBatchLevel(0)
Line 68:		Line 69:
	impl;		impl;
	}		}
	</pre>		</pre>
	Use namespace mozilla::places where possible, or anonymous namespace for file scope.		Use namespace mozilla::places where possible, or anonymous namespace for file scope.

	Add Places or nsPlaces in front of components or modules names, so that they are easily recognizeable in components/modules folders and also to prevent naming conflicts.		Add Places or nsPlaces in front of components or modules names, so that they are easily recognizeable in components/modules folders and also to prevent naming conflicts.

Mak77: Created page with 'As a general rule we follow conventions reported in the global coding style page: https://developer.mozilla.org/En/Developer_Guide/Coding_Style With some differences: if/else…'

2009-12-15T13:52:43Z

Created page with 'As a general rule we follow conventions reported in the global coding style page: https://developer.mozilla.org/En/Developer_Guide/Coding_Style With some differences: if/else…'

New page

As a general rule we follow conventions reported in the global coding style page: https://developer.mozilla.org/En/Developer_Guide/Coding_Style

With some differences:

if/else if/else conditions, as well as try/catch should never be inline with braces:
<pre>if (condition) {
statement1;
statement2;
}
else if (condition) {
statement1;
statement2;
}
else {
statement1;
statement2;
}

try {
statement;
}
catch(ex) {}

</pre>
Oneliners statements inside if/elseif/else conditions can avoid braces, but if any side of the condition uses braces then all sides will take them: 
<pre>if (condition)
statement;
else
statement;

if (condition) {
statement;
}
else {
statement1;
statement2;
}
</pre>
When instantiating services in cpp use this form: 
<pre>nsCOMPtr<nsIAnnotationService> annoSvc =
do_GetService(NS_ANNOTATIONSERVICE_CONTRACTID);
NS_ENSURE_TRUE(annoSvc, NS_ERROR_OUT_OF_MEMORY);
</pre>
To null check other objects use NS_ENSURE_STATE(obj); 

When defining cpp methods opening brace goes in new line: 
<pre>type* newMethod(type param)
{
impl;
}
</pre>
Constructors params are inited like this (notice order of inited params should be the same as they are defined in the class definition, otherwise GCC will warn) 
<pre>nsNavHistory::nsNavHistory()
: mBatchLevel(0)
, mBatchHasTransaction(PR_FALSE)
, mCachedNow(0)
, mExpireNowTimer(nsnull)
, mExpireDaysMin(0)
, mExpireDaysMax(0)
, mExpireSites(0)
, mNumVisitsForFrecency(10)
, mTagsFolder(-1)
, mInPrivateBrowsing(PRIVATEBROWSING_NOTINITED)
, mDatabaseStatus(DATABASE_STATUS_OK)
, mCanNotify(true)
, mCacheObservers("history-observers")
{
impl;
}
</pre>
Use namespace mozilla::places where possible, or anonymous namespace for file scope.

Add Places or nsPlaces in front of components or modules names, so that they are easily recognizeable in components/modules folders and also to prevent naming conflicts.