SitePoint Sponsor

User Tag List

Results 1 to 3 of 3

Thread: Code reviews

Threaded View

  1. #1
    Unobtrusively zen silver trophybronze trophy
    paul_wilkins's Avatar
    Join Date
    Jan 2007
    Location
    Christchurch, New Zealand
    Posts
    14,705
    Mentioned
    101 Post(s)
    Tagged
    4 Thread(s)

    Lightbulb Code reviews

    If you are looking for a code review or suggestions on how to improve on code you've written then please prefix the summary of your thread with [Code Review]. That will alert our resident experts to comment on the code you have written.

    Please do not use the Code review title for normal bug hunting, but rather when you have accomplished something and wonder if you could have done it better.

    It is preferable to post the snippet of code in question as well as a link to the site to help in working out what issues need to be addressed. Don't just link to the whole site and say review this code, be specific about what you want reviewed.

    Please use the highlight function with the appropriate syntax.
    To highlight your code as javascript, select your code, and then from the Select Syntax... dropdown list, choose JavaScript.

    That will wrap your code in tags like this:

    [highlight="javascript"]
    var someValue = 0;
    var anotherValue = 'something else';
    doSomething(someValue, anotherValue);
    [/highlight]

    Which causes your code to be displayed like this:

    Code javascript:
    var someValue = 0;
    var anotherValue = 'something else';
    doSomething(someValue, anotherValue);

    Highlighting your code with the appropriate syntax makes it much easier for people to read and understand your code, which in turn makes it easier for them to help with your code.

    Be aware that you may get conflicting and opposing views from different people. Ultimately it will be your task to sift through the information and make a decision based on what you have read. There is usually no one perfect way to do something, although there are established best practices.

    Remember this is just about reviewing the code only, as website Design elements and Content reviews already have their own forums.

    If this facility proves useful then these reviews may get their own dedicated forum at a later date.
    Last edited by paul_wilkins; Apr 23, 2011 at 15:22.
    Programming Group Advisor
    Reference: JavaScript, Quirksmode Validate: HTML Validation, JSLint
    Car is to Carpet as Java is to JavaScript


Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •