问题描述
为有条件地返回内容或class A {
int a,b,c;
public:
A(int x,int y,int z) {
a = x;
b = y;
c = z;
}
friend class B;
};
class B: public A {
public:
void add5() {
a += 5;
b += 5;
c += 5;
}
};
int main() {
A ob1(10,12,13);
B obj;
obj.add5();
return 0;
}
的函数编写文档字符串的惯例是什么？我看到了一些使用Sphinx与此相关的帖子，但我想知道以下代码中的格式约定是什么：
nonetype解决方法
没有单一样式的文档字符串；不同的项目会以不同的方式构造它们，因此，如果没有现有的处理方法示例，您应该随意使用适合您的方法。
PEP-257概述了一些最重要的通用准则
函数或方法的文档字符串应总结其行为并记录其自变量，返回值，副作用，引发的异常以及何时可以调用它的限制（所有这些均适用）。应该指出可选参数。应该记录关键字参数是否是接口的一部分。
我认为您写的内容不错。
作为记录，您不需要else块。执行而未显式返回的Python函数将返回None。另外，返回的if块实际上不需要else，因为它们之后的代码只有在不满足条件的情况下才会执行。