如何提供几个工作功能的例子？

Question

假设我有一个功能：

void isUniqueSymbols(string stream)

如何理解我应该提供几个我的功能如何工作的例子？ 我可以这样写：

Input: isUniqueSymbols("abcde");
Output: true;

Input: isUniqueSymbols("abcdee");
Output: false;

但不确定这是否正确。

您如何提供工作职能的示例？

Answer 1

一种可能性是将文档嵌入代码中：

assert(isUniqueSymbols("abcde"));
assert(!isUniqueSymbols("abcdee"));

这非常接近单元测试/查看单元测试作为文档，无论可能值得什么。