Tag: 编码风格的

什么是最好的Python库模块的骨架代码？

很多python IDE将会以如下模板启动你： print 'hello world' 这是不够的…所以这里是我的骨架代码来开始这个问题： 我的模块骨架，简短版本： #!/usr/bin/env python """ Module Docstring """ # ## Code goes here. # def test(): """Testing Docstring""" pass if __name__=='__main__': test() 和， 我的模块骨架，长版本： #!/usr/bin/env python # -*- coding: ascii -*- """ Module Docstring Docstrings: http://www.python.org/dev/peps/pep-0257/ """ __author__ = 'Joe Author (joe.author@website.org)' __copyright__ = 'Copyright (c) 2009-2010 Joe Author' __license__ […]

C ++函数注释的最佳实践

有没有公​​认的评论function的最佳做法？ 我只知道doxygen风格，但它不是正式的C ++支持，就像Javadocs是Java的，所以只是想知道什么是最好的。

Python“私有”函数编码约定

当编写一个python模块和函数时，我有一些应该暴露给外部人员的“公共”函数，但是一些其他“私人”函数只能在本地和内部看到和使用。 我明白在Python中没有绝对的私人function。 但是，将“公共”function与“私人”function区分开来的最好，最简洁，最常用的风格是什么？ 我列出了一些我知道的风格： 在模块文件中使用__all__来表示它的“公共”函数（ 什么是Python的__all__模块级variables？ ） 在“私人”function名称的开头使用下划线 有没有人使用的其他想法或惯例？ 非常感谢你！

在Python中导入模块 – 最佳实践

我是Python的新手，因为我想要扩展使用R学习的技能。在RI中往往会加载一堆库，有时会导致函数名称冲突。 Python中的最佳实践是什么？ 我看到一些具体的变化，我没有看到之间的差异 from pandas import * import pandas ， from pandas import DataFrame 前两者之间有什么区别，我应该只是import我所需要的。 另外，对于那些让小程序来处理数据和计算简单统计数据的人来说，最糟糕的后果是什么？ UPDATE 我发现这个优秀的指南 。 它解释了一切。

Lisp括号

为什么Lispers将它们的代码格式化，如示例1所示，而不是示例2中所示？ 对我来说（对于来自不同编程背景的大多数其他人来说，除了Lisp之外），示例2中显示的格式将更易于阅读。 Lispers喜欢样本1风格有什么特别的原因吗？ 样品1 (defun factorial (n) (if (<= n 1) 1 (* n (factorial (- n 1))))) 样品2 (defun factorial (n) (if (<= n 1) 1 (* n (factorial (- n 1))) ) )

你如何通过SSH编辑文件？

我使用eclipse编程，有时使用像SciTE或vim这样的GUI文本编辑器。 不过，我在某个项目中需要我通过80列SSH窗口中的ssh连接来编辑文件。 由于我必须（* shiver *） sudo vim才能打开文件，我不知道如何在terminal外的编辑器中打开文件（这将允许我看到比80列更宽的文本）。 如果命令行较大，那么我认为使用直接的vim不会是一个问题。 我不知如何处理这种情况，以及如何将这个噩梦变成一个可pipe理的编码环境。

你如何使错误的代码看起来不对？ 你使用什么模式来避免语义错误？

自从我第一次犯了错误， if我总是写这样的ifs： if (CONST == variable) { 避免常见（至less对我来说）这样做的错误： if (variable = CONST) { //WRONG, assigning 0 to variable 而且自从我读了乔尔·斯波尔斯基（Joel Spolsky）的文章“ 使错误的代码看起来错了”以来，我一直在试图将他的build议付诸实践。 那么，如果你犯了一个语义错误，你还会使用其他什么模式来使错误的代码看起来错误，或者强制语法错误？

为什么会变成一件坏事？

我有一天和同事聊天，听说他们的编码标准明确地禁止他们在C＃中使用var关键字。 他们不知道为什么是这样，我总是发现隐式声明在编码时非常有用。 我从来没有发现什么types的variables的问题（你只是hover在VS的variables，你会得到这种types的方式）。 有谁知道为什么在C＃中使用var关键字是一个坏主意？

命名约定：什么命名布尔variables？

我需要一个好的variables名称作为布尔值，当一个对象是列表中的最后一个时返回false。 我能拿出来的唯一体面的名字是“inFront”，但是我不认为这是足够描述的。 另一个select将是'isNotLast'。 尽pipe如此（代码完成，第269页，使用正布尔variables名称），这并不是一个好习惯。 我知道我可以改变variables的定义。 所以当一个对象是最后一个对象时，返回true，并调用variablesisLast，但是，如果我有第一个解释，它会使这个任务更容易。

函数名称在C ++中：是否大写？

C ++中命名函数的约定是什么？ 我来自Java环境，所以我通常是这样命名的： myFunction(…) { } 我看过C ++中的混合代码， myFunction(….) MyFunction(….) Myfunction(….) 什么是正确的方法？ 另外，类方法和非类方法是一样的吗？