c++ - 如何提供几个工作函数的例子？

Question

假设我有一个功能：

void isUniqueSymbols(string stream)

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

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

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

但不确定这是否正确。

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

Answer 1

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

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

这非常接近于单元测试/将单元测试作为文档查看，无论它可能有价值。