Difference between revisions of "User:Crutchy"
|Line 17:||Line 17:|
Revision as of 23:36, 4 March 2014
I'm from Australia.
PHP/SQL/HTML/CSS and Delphi (Object Pascal) are my preferred languages.
I'm pedantic about code etiquette (indents, spaces, etc).
New to Perl but interested in learning. I have a basic perl virtual host set up on my dev machine. Also got the slashdev virtual machine going, which makes the prospect of being able to contribute something that might be considered useful to the project a bit more likely.
Look out for me on #Soylent IRC.
Crutchy's perl journal: http://soylentnews.org/~crutchy/journal/72
Code doc project: http://soylentnews.org/~crutchy/journal/82
slashdev journal: http://soylentnews.org/~crutchy/journal/114
An area that I've been getting into a bit more with some of my other (mainly php) work. It's supposed to be that you write the tests first, but since slashcode is already written it's a bit hard to do that, but some kind of automated regression testing framework probably wouldn't hurt.
Perl programming style guide:
Just to start the ball rolling ("borrowed" from perl.org):
- closing curly bracket of a multi-line BLOCK should line up with the keyword that started the construct
- 4-column indent (slashcode uses tab indents, but in gedit you can set tab width or raplace tabs - tab may be better anyway?)
- Opening curly on same line as keyword, if possible, otherwise line up
- Space before the opening curly of a multi-line BLOCK
- One-line BLOCK may be put on one line, including curlies
- No space before the semicolon
- Semicolon omitted in "short" one-line BLOCK
- Space around most operators
- Space around a "complex" subscript (inside brackets)
- Blank lines between chunks that do different things
- Uncuddled elses
- No space between function name and its opening parenthesis
- Space after each comma
- Long lines broken after an operator (except and and or )
- Space after last parenthesis matching on current line
- Line up corresponding items vertically
- Omit redundant punctuation as long as clarity doesn't suffer
If anyone has any others or wants to change any, feel free to do so. Maybe add a reason/background in change summary just so others know where you're coming from.
We should maybe make a wiki page for coding style and develop it so that all our code is readable and consistent regardless of author.
Also looking for one for other languages used for Soylent: CSS, HTML, JS, SQL
Goes without saying, but HTML and CSS should be W3C compliant.
IHMO there are way too many folders nested in the slashcode source tree. There may be good reasons but I generally prefer a flat filesystem (as much as possible anyway) for code accessibility. Also helps to reduce likelihood of duplicate filenames. In the slashdev virtual machine I noticed that the apache public directory has links to a lot of the key files in a single directory, which makes things a lot easier.
What do other devs think of prefixing function names with source filename?
For example, main() function in article.pl becomes article__main()
Not suggesting that it all be changed to suit this convention right away, but might be handy for new functions to make it easier to figure out where things are declared.
gedit identifies a syntax error in shtml.pl getFileText function (line 74). Looks like a rogue "s" after the "!-" operator.