Ruby Formatting

最新推荐文章于 2024-04-01 14:02:45 发布

yang_kunlun

最新推荐文章于 2024-04-01 14:02:45 发布

阅读量105

点赞数

分类专栏： Code style 文章标签： Ruby SQL UP

Code style 专栏收录该内容

3 篇文章

订阅专栏

本文详细介绍了在编程过程中应遵循的一些重要代码规范，包括缩进、注释、变量命名、代码块格式化等方面的内容，并强调了良好的代码习惯对于提高代码可读性和维护性的重要性。

1. Two spaces indentation
2. Comments
New:

# The comment

Old:

# The comment

3. Whitespace should be used to split up the code, not random
4. Lining up and spacing
4.a spaces between variables and equals
4.b lining up

New:

@task_data = WorkItem.find_by_sql(str_task)
@project_data = WorkItem.find_by_sql(str_project)

Old:

@task_data=WorkItem.find_by_sql(str_task)
@project_data=WorkItem.find_by_sql(str_project)

5. use #{}
instead of escpaing out

= '" + @day_info.original_id.to_s + "' group

6. Don't commit large blocks of commented code (i.e. daicens version)

7. Case statments use

case
when "bla" then something
when "bla2" then something_else
else "something"
end

or

case
when "bla"
then something
when "else"
then something

8. Don't explicitly use "return" unless you need it
i.e.
new:

def bla
whatever
end

old:
def bla
return whatever
end

9. format your blocks
instead of

new_object.delete_if{|key,value|(key=='id')||(key=='revision')||(key=='lastModifiedByClient')||(key=='regularTime')||(key=='hasWorkItems')||(key=='hasInvalidWorkItems')||(key=='hasTags')}