PageRenderTime 163ms CodeModel.GetById 1ms RepoModel.GetById 0ms app.codeStats 0ms

/lib/Joose/Manual/BestPractices.js

http://github.com/Joose/Joose
JavaScript | 58 lines | 0 code | 0 blank | 58 comment | 0 complexity | 7149a58ddb08a7346ede5cdf2fe843b0 MD5 | raw file
    

  1. /**
    2. 

    3. 

  3. NAME
    4. 

  4. ====
    5. 

    6. 

  6. Joose.Manual.BestPractices - Get the most out of Joose
    7. 

    8. 

    9. 

  9. RECOMMENDATIONS
    10. 

  10. ===============
    11. 

    12. 

  12. Joose has a lot of features, and there's definitely more than one way to do it. However, we think that picking a subset of these features and using them consistently makes everyone's life easier.
    13. 

    14. 

  14. Of course, as with any list of "best practices", these are really just opinions. Feel free to ignore us.
    15. 

    16. 

    17. 

  17. Best practice #1
    18. 

  18. ----------------
    19. 

    20. 

  20. This is very wise advise on using Joose properly.
    21. 

    22. 

    23. 

  23. BENEFITS OF BEST PRACTICES
    24. 

  24. ==========================
    25. 

    26. 

  26. Following these practices has a number of benefits.
    27. 

    28. 

  28. It helps ensure that your code will play nice with others, making it more reusable and easier to extend.
    29. 

    30. 

  30. Following an accepted set of idioms will make maintenance easier, especially when someone else has to maintain your code. It will also make it easier to get support from other Joose users, since your code will be easier to digest quickly.
    31. 

    32. 

  32. Many of these practices also help get the most out of meta programming. 
    33. 

    34. 

    35. 

  35. AUTHOR
    36. 

  36. ======
    37. 

    38. 

  38. Nickolay Platonov [nickolay8@gmail.com](mailto:nickolay8@gmail.com)
    39. 

    40. 

  40. Heavily based on the original content of Moose::Manual, by Dave Rolsky [autarch@urth.org](mailto:autarch@urth.org)
    41. 

    42. 

    43. 

  43. COPYRIGHT AND LICENSE
    44. 

  44. =====================
    45. 

    46. 

  46. Copyright (c) 2008-2011, Malte Ubl, Nickolay Platonov
    47. 

    48. 

  48. All rights reserved.
    49. 

    50. 

  50. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
    51. 

    52. 

  52. * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    53. 

  53. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    54. 

  54. * Neither the name of Malte Ubl nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 
    55. 

    56. 

  56. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
    57. 

    58. 

  58. */
    59. 

  59.