StyleGuide - Revision history

Kgoetz: restore link broken by accidentally editing old revision

2018-09-11T23:51:43Z

restore link broken by accidentally editing old revision

← Older revision		Revision as of 23:51, 11 September 2018
Line 215:		Line 215:

	==Automatically reformatting code==		==Automatically reformatting code==
	There is a wonderful utility called ''perltidy'' (~~find link~~)		There is a wonderful utility called ''perltidy''' ([http://perltidy.sourceforge.net/ website])

	This reformats perl for you (and does a syntax check at the same time... lovely.		This reformats perl for you (and does a syntax check at the same time... lovely.

2018-09-11T23:50:40Z

Change category Developer to Contribute

← Older revision		Revision as of 23:50, 11 September 2018
Line 1:		Line 1:
	[[Category:Contribute]]		[[Category:Contribute]]
	~~[[Category:Developer]]~~
	EPrints has been under development for many years and has some fluff about the place. For new programmers this document is intended as a 'style guide' to at least keep the code and documentation consistent across new [[modules]].		EPrints has been under development for many years and has some fluff about the place. For new programmers this document is intended as a 'style guide' to at least keep the code and documentation consistent across new [[modules]].

Line 216:		Line 215:

	==Automatically reformatting code==		==Automatically reformatting code==
	There is a wonderful utility called ''perltidy'' (~~[http://perltidy.sourceforge.net/ website]~~)		There is a wonderful utility called ''perltidy'' (find link)

	This reformats perl for you (and does a syntax check at the same time... lovely.		This reformats perl for you (and does a syntax check at the same time... lovely.

2012-11-23T10:14:27Z

Automatically reformatting code

← Older revision		Revision as of 10:14, 23 November 2012
Line 216:		Line 216:

	==Automatically reformatting code==		==Automatically reformatting code==
	There is a wonderful utility called ''perltidy'' (~~find link~~)		There is a wonderful utility called ''perltidy'' ([http://perltidy.sourceforge.net/ website])

	This reformats perl for you (and does a syntax check at the same time... lovely.		This reformats perl for you (and does a syntax check at the same time... lovely.

2010-02-08T17:09:52Z

← Older revision		Revision as of 17:09, 8 February 2010
Line 1:		Line 1:
			[[Category:Contribute]]
			[[Category:Developer]]
	EPrints has been under development for many years and has some fluff about the place. For new programmers this document is intended as a 'style guide' to at least keep the code and documentation consistent across new [[modules]].		EPrints has been under development for many years and has some fluff about the place. For new programmers this document is intended as a 'style guide' to at least keep the code and documentation consistent across new [[modules]].

2009-08-12T09:22:58Z

Local Variables

← Older revision		Revision as of 09:22, 12 August 2009
Line 24:		Line 24:
	Local variables should be given names that reflect their content ($authenticated) rather than a short nmenonic ($au). Local variables should be underscore seperated ($current_password), not camelCased ($currentPassword)		Local variables should be given names that reflect their content ($authenticated) rather than a short nmenonic ($au). Local variables should be underscore seperated ($current_password), not camelCased ($currentPassword)

	'The appropriate length of a name is inversely proportional to the size of its scope.' --Mark-Jason Dominus		''The appropriate length of a name is inversely proportional to the size of its scope.'' --Mark-Jason Dominus
	'Choose mnemonic identifiers. If you can't remember what mnemonic means, you've got a problem.' -- Larry Wall
			''Choose mnemonic identifiers. If you can't remember what mnemonic means, you've got a problem.'' -- Larry Wall

	Preferred technique:		Preferred technique:

2009-08-10T12:08:56Z

← Older revision		Revision as of 12:08, 10 August 2009
Line 79:		Line 79:

	package EPrints::Plugin::Sword::Import::FiddleDeeDee		package EPrints::Plugin::Sword::Import::FiddleDeeDee

			See the [[modules]] page for full details.

	===General layout/presentation notes===		===General layout/presentation notes===

2009-08-10T12:07:54Z

← Older revision		Revision as of 12:07, 10 August 2009
Line 61:		Line 61:
	Private functions are the subroutines in your modules that people should '''not''' be using.		Private functions are the subroutines in your modules that people should '''not''' be using.
	Private functions should start with an underscore, and have simple perl comments above them, explaining the function of the subroutine.		Private functions should start with an underscore, and have simple perl comments above them, explaining the function of the subroutine.
			<pre>
			#########
			#
			# _my_subby( $var_1, %var_2 ):
			#
			# Description of function, with examples
			#
			sub _my_subby
			{

			}
			</pre>
	====Modules====		====Modules====
	Modules (aka ''packages'') are the file that contains the collection of methods & private funtions that makes your code do whatever it does.		Modules (aka ''packages'') are the file that contains the collection of methods & private funtions that makes your code do whatever it does.

2009-08-10T12:06:24Z

Public methods

← Older revision		Revision as of 12:06, 10 August 2009
Line 43:		Line 43:

	Public methods must start with a lowe-case letter [a-z], and are required to have [http://perldoc.perl.org/perlpod.html POD] above them explaining the function and use of the method.		Public methods must start with a lowe-case letter [a-z], and are required to have [http://perldoc.perl.org/perlpod.html POD] above them explaining the function and use of the method.
			<pre>
			=pod

			=item * my_func( $var_1, %var_2 ):

			Description of function, with examples

			=cut

			sub my_func
			{

			}
			</pre>

	=====Private methods=====		=====Private methods=====

2009-08-10T12:03:29Z

Packages

← Older revision		Revision as of 12:03, 10 August 2009
Line 183:		Line 183:
	Try and use "next" rather than if when inside loops.		Try and use "next" rather than if when inside loops.

	~~==Packages==~~

2009-08-10T12:00:32Z

@@ Line 1: / Line 1: @@
-EPrints has been under development for many years and has some fluff about the place. For new programmers this document is intended as a 'style guide' to at least keep the code and documentation consistent across new modules.
+EPrints has been under development for many years and has some fluff about the place. For new programmers this document is intended as a 'style guide' to at least keep the code and documentation consistent across new [[modules]].
 ==Programming Style==
@@ Line 183: / Line 183: @@
 Try and use "next" rather than if when inside loops.
-==Description==
+==Packages==
 ==Automatically reformatting code==