CSC/ECE 517 Fall 2012/ch1 1w23 ph

From Expertiza_Wiki
Revision as of 00:25, 16 September 2013 by Pyadla (talk | contribs)
Jump to navigation Jump to search

Ruby Coding Guidelines

Designed and developed in the mid-1990s by Yukihiro "Matz" Matsumoto in Japan, Ruby embodies syntax inspired by Perl with Smalltalk-like features and was also influenced by Eiffel and Lisp. Ruby Coding Guidelines include best practices followed generally for most of the object oriented programming languages as Ruby is entirely 'Object Oriented'. Also known as 'Ruby Coding conventions', these are a set of guidelines that recommend programming style, practices and methods for each aspect of a piece of program written in Ruby.

Software programmers are highly recommended to follow these guidelines to help improve the readability of their source code and make software maintenance easier. Naming conventions, class and member design principles, maintainability, performance, documentation and layout are the important areas where these guidelines have to be followed. More important than the reasons for having a guideline is actually adhering to it consistently. Having a coding guideline documented and available means nothing if developers are not using it consistently.


Importance of guidelines

Types of Guidelines

Naming Guidelines

Class Design Guidelines

Member Design Guidelines

Maintainability Guidelines

Performance Guidelines

Documentation Guidelines

Layout Guidelines

Code Analysis Tools

Summary

See Also

References