gpt4 book ai didi

C++ 函数注释/契约

转载 作者:太空狗 更新时间:2023-10-29 20:33:31 27 4
gpt4 key购买 nike

<分区>

您好,我确实在大学学习了 C++,但是没有人教我们如何正确地注释我们的代码。我认为代码的可读性非常重要。

现在我的问题是:我是否必须将函数/方法契约/注释写入函数声明或实现?

例子:

排序.h

class Sort{
public:
/**
* Simple Bubble Sort algorithm
*
* @param list vector of strings to sort
* @return sorted vector of strings
*/
static std::vector<std::string> bubbleSort(std::vector<std::string> list);
};

排序.cpp

#include "sort.h"

/**
* Simple Bubble Sort algorithm
*
* @param list vector of strings to sort
* @return sorted vector of strings
*/
std::vector<std::string> Sort::bubbleSort(std::vector<std::string> list){
//Do anything
}

哪个 Commet 是正确的?

27 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com