脚本编程：使用参数在单独的文件中开发函数

Question

在使用脚本语言（Python、Perl、Ruby或R）编程时，我尝试编写函数并将它们保存在单独的文件中，以保持代码的模块化。你知道吗

为了调试，我经常把函数的参数放在函数体中，一完成就取消注释。你知道吗

此外，我经常在函数定义之后调用函数，在完成测试时也会取消注释。你知道吗

最后，我的文件是这样的

def add(a, b):
    # a = 1
    # b = 2
    c = a + b
    return c

# add(1, 2)

有没有更优雅的方法来实现这一点？你知道吗

此外，我认为通常的做法是在将代码发送给其他人时删除这些注释。有没有一种方法可以以类似JavaDoc的方式实现这一点，同时保留“真实”的注释（即不是未注释的代码）？你知道吗

我应该提到的是，我经常围绕Matplotlib或R（ggplot等）中的plot函数调用编写包装函数，因为在这些情况下，输出是一个图，所以它不太适合测试驱动的开发框架。你知道吗

Answer 1

正确的方法是编写一些单元测试。
如果您想让您的测试非常接近源代码，您应该签出doctest模块，它允许您运行直接放在文档注释中的测试。
整洁的东西。
编辑： 在你的例子中，它看起来是这样的：

def add(a, b): 
    """ Returns sum of a and b

    >>> add(1, 2)
    3

    """
    c = a + b
    return c

然后像这样运行测试：

python -m doctest -v yourFile.py