标签: conventions

良好的Haskell编码标准

有人可以为Haskell提供良好编码标准的链接吗?我发现了这个这个,但它们远非全面.更不用说HaskellWiki包含诸如"谨慎使用类"之类的"宝石","定义符号中缀标识符应仅留给图书馆作者".

haskell coding-style conventions

74
推荐指数
4
解决办法
1万
查看次数

Python:使用4个空格进行缩进.为什么?

在编写python时,我只使用2个空格来缩进,确定PEP-8确实建议有4个空格,但从历史上看,这是不寻常的.

那么,任何人都可以说服我使用4个空格而不是2个空格吗?有什么优点和缺点?

PS最后,将所有现有代码库从2个空间转换为4个空格的简单方法是什么?


PPS PEP-8还建议不要使用标签进行缩进.在这里阅读


所以,总结一下:

优点:

  • 包裹超过80行的字符串时有更多的空间来安排.
  • 可以从代码片段中复制代码,它只是起作用.

缺点:

  • 使用更深层次的嵌套语句,您可以减少实际代码的空间.

谢谢.

python conventions pep8 indentation

69
推荐指数
9
解决办法
6万
查看次数

输入deff指针是个好主意吗?

我查看了一些代码并发现惯例是将指针类型转换为

SomeStruct* 
Run Code Online (Sandbox Code Playgroud)

typedef SomeStruct* pSomeStruct;
Run Code Online (Sandbox Code Playgroud)

这有什么好处吗?

c c++ pointers typedef conventions

68
推荐指数
9
解决办法
4万
查看次数

Python"私有"函数编码约定

在编写python模块和函数时,我有一些应该暴露给外人的"公共"函数,但是其他一些"私有"函数只能在本地和内部看到和使用.

我理解在python中没有绝对的私有函数.但是,区分"公共"功能和"私人"功能的最佳,最整洁或最常用的风格是什么?

我列出了一些我所知道的风格:

  1. __all__在模块文件中使用以指示其"公共"函数(python __all__模块级变量是什么?)
  2. 在"私有"函数名称的开头使用下划线

人们使用其他任何想法或约定吗?

非常感谢你!

naming coding-style conventions python-2.7

62
推荐指数
1
解决办法
5万
查看次数

Lisp评论大会

有关用于不同类型注释的分号数量(以及不同数量的分号的缩进程度应该是多少)的Lisp约定是什么?

另外,是否有关于何时使用分号注释以及何时使用的约定#|multiline comments|#(假设它们存在且存在于多个实现中)?

lisp comments conventions common-lisp

60
推荐指数
5
解决办法
4万
查看次数

如何发出"尚未实施"的信号?

在初始绘制新gem时,我需要将一些方法实现留空(将在下一个实现)

因此,我想发出一个"尚未实施"的例外情况

我想知道是否有一个特定于Ruby语言的最佳实践标准约定来编写这种占位符/异常.

即:像:

ruby coding-style exception-handling conventions

59
推荐指数
2
解决办法
2万
查看次数

何时在菜单项后使用省略号

在几乎所有具有菜单栏的应用程序中,一些项目后面都有省略号(...),有些则没有.是否有一个众所周知的约定,何时将省略号放在那里,何时不放?你什么时候做的?你做到了吗?

我看过各种windows应用程序,这就是我要来的:

  • 省略

    • 打开表单的菜单项,需要用户输入才能执行某些操作(替换,转到,字体)
  • 没有省略号

    • 只做某事的菜单项(剪切,粘贴,退出,保存)
    • 菜单项打开不需要用户输入的表单(关于,检查更新)

但是,似乎总是存在不符合此规则的菜单项.例如,Visual Studio中的帮助项(如何,搜索,索引)以及查找和替换(快速查找,在文件中查找,查找符号).

所以在考虑了一下后,我现在认为这可能是事情:

  • 省略

    • 菜单项肯定会打开一个模态窗口.
  • 没有省略号

    • 用于打开非模态窗口的菜单项.
    • 没有打开任何窗口的菜单项.
    • 很可能无法打开模态窗口的菜单项(如"保存",如果之前没有保存过,则会打开模态窗口,或者其他类似的东西)

你们有什么感想?

standards user-interface menu conventions

51
推荐指数
1
解决办法
2万
查看次数

在Clojure中使用命名空间的常见约定是什么?

我在Clojure中找到使用命名空间的好建议和常用做法时遇到了麻烦.我意识到命名空间与Java包不同,所以我试图梳理Clojure中的约定,这似乎很难确定.

我想我非常清楚如何将函数分成clj文件,甚至大致如何将这些文件组织到目录中.但除此之外,我无法为我的开发环境找到机制.一些相互关联的问题:

  1. 对于Clojure命名空间,我是否使用与通常用于Java包的相同的唯一性约定?[即backwards-company-domain.project.subsystem]
  2. 我应该将文件保存在与我的命名空间匹配的目录结构中吗?[ala Java]
  3. 如果我有多个名称空间,是否需要将所有代码编译到jar中并将其添加到我的类路径中以使其可访问?
  4. 每个命名空间应该编译成一个jar吗?或者我应该创建一个包含来自许多名称空间的clj代码的jar?

谢谢...

namespaces conventions clojure project-organization

50
推荐指数
2
解决办法
6554
查看次数

Ruby中的标准文件命名约定

对于包含给定类SomeCoolClass的文件,什么是正确的文件名?

 1. somecoolclass.rb
 2. some_cool_class.rb
 3. some-cool-class.rb
 4. SomeCoolClass.rb

或其他一些变化?

我注意到在Ruby stdlib中使用了版本1,2和3.

ruby file conventions naming-conventions

49
推荐指数
4
解决办法
2万
查看次数

'src/main/java''约定的优点是什么?

我注意到很多项目都有以下结构:

  • 项目-A
    • 箱子
    • LIB
    • SRC
      • 主要
        • java的
          • RootLevelPackageClass.java

我目前使用以下约定(因为我的项目是100%java):

  • 项目-A
    • 箱子
    • LIB
    • SRC
      • RootLevelPackageClass.java

我目前没有使用Maven,但我想知道这是否是Maven约定或者是否还有其他原因.有人可以解释为什么第一个版本如此受欢迎,如果我应该采用这个新的约定?

克里斯

java coding-style conventions

49
推荐指数
5
解决办法
2万
查看次数