编写C语言函数和函数调用返回指针的好的编程风格是什么?
例如,如果我有一个函数my_function,它通过指针参数返回两个整数。我应该如何调用这个函数,以便不熟悉我的代码的人很容易看到它返回两个值?
我应该如何编写函数定义呢?
例如,我总是可以将返回值放在参数列表的最后,当我调用函数时,我可以添加一些额外的空间来将输入参数与返回值分开。
此外,对于函数定义,我可以在输入参数和返回值之间添加一个带有注释的空行。例如:
void my_function(
int a,
int b,
/* return values */
int *c,
int *d)
{
/* do something */
}
int main()
{
int a = 1;
int b = 2;
int c;
int d;
my_function(a,b, &c, &d);
}发布于 2015-03-02 10:05:15
您可以在函数定义中注意到信息流:
void my_function(
/* in */ int a,
/* in */ int b,
/* out */ int* c,
/* out */ int* d)
{
/* do something */
}这样,就很容易看到发生了什么。如果导出此函数,还将在原型中包含注释,以便每个人都能看到信息流的方向。
此外,在你的功能中坚持一种风格。例如,如果您始终将返回值写入参数列表的末尾,并且有人看到您正在调用
whatever(p1, p2, p3, &p4);人们会知道,p4很有可能是函数的返回值。
发布于 2015-03-02 12:16:47
我会用一个工具来记录代码。例如,使用强力氧原,您可以编写:
/**
* \brief Performs something and stores result in \a c and \a d
*
* \param[in] a ...
* \param[in] b ...
* \param[out] c ...
* \param[out] d ...
*
* Detailed description here.
*/
void my_function(int a, int b, int *c, int *d)
{
/* do something */
}这个特殊的注释块有一个简单的结构(它是一个带有一些附加标记的C注释块)。因此,它很容易阅读,同时允许提取文档。
排序函数参数,以便所有只输入的参数都在任何输出参数之前,在C中很常见,但它不是唯一的选项(例如,memcpy)。
无论如何,最重要的方面是统一的代码风格。
一般情况下,只要可能,我就尽量避免输出参数。
还考虑到:
div / ldiv / C99 lldiv函数来自<stdlib.h>);有些相关:
https://softwareengineering.stackexchange.com/questions/274934
复制相似问题