Question

对于注释来讲，一个精心挑选的输入/输出例子比千言万语还有效。

例如，下面是一个用来移除部分字符串的通用函数：

这条注释不是很精确，因为它不能回答下列问题：

·chars是整个要移除的子串，还是一组无序的字母？

·如果在src的结尾有多个chars会怎样？

然而一个精心挑选的例子就可以回答这些问题：

这个例子展示了Strip()的整个功能。请注意，如果一个更简单的示例不能回答这些问题的话，它就不会那么有用：

下面是另一个函数的例子，也能说明这个用法：

这段注释实际上很精确，但是不直观。可以用下面的例子来进一步解释：

对于我们所选择的特别的输入/输出例子，有以下几点值得提一下：

·pivot与向量中的元素相等，用来解释边界情况。

·我们在向量中放入重复元素（8）来说明这是一种可以接受的输入。

·返回的向量没有排序——如果是排好序的，读者可能会误解。

·因为返回值是1，我们要确保1不是向量中的值——否则会让人很困惑。