首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >使用指针从c函数返回多个值;参数列表的样式

问使用指针从c函数返回多个值;参数列表的样式
EN

Software Engineering用户
提问于 2015-03-02 09:52:37
回答 2查看 7.8K关注 0票数 3

编写C语言函数和函数调用返回指针的好的编程风格是什么?

例如,如果我有一个函数my_function,它通过指针参数返回两个整数。我应该如何调用这个函数,以便不熟悉我的代码的人很容易看到它返回两个值?

我应该如何编写函数定义呢?

例如,我总是可以将返回值放在参数列表的最后,当我调用函数时,我可以添加一些额外的空间来将输入参数与返回值分开。

此外,对于函数定义,我可以在输入参数和返回值之间添加一个带有注释的空行。例如:

代码语言:javascript
复制
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);
}
EN

回答 2

Software Engineering用户

回答已采纳

发布于 2015-03-02 10:05:15

您可以在函数定义中注意到信息流:

代码语言:javascript
复制
void my_function(
   /*  in */ int  a,
   /*  in */ int  b,
   /* out */ int* c,
   /* out */ int* d)
{
   /* do something */
}

这样,就很容易看到发生了什么。如果导出此函数,还将在原型中包含注释,以便每个人都能看到信息流的方向。

此外,在你的功能中坚持一种风格。例如,如果您始终将返回值写入参数列表的末尾,并且有人看到您正在调用

代码语言:javascript
复制
whatever(p1, p2, p3, &p4);

人们会知道,p4很有可能是函数的返回值。

票数 4
EN

Software Engineering用户

发布于 2015-03-02 12:16:47

我会用一个工具来记录代码。例如,使用强力氧原,您可以编写:

代码语言:javascript
复制
/**
 *  \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)。

无论如何,最重要的方面是统一的代码风格。

一般情况下,只要可能,我就尽量避免输出参数。

还考虑到:

  • 在C标准中,返回包含所有结果的结构是有先例的( div / ldiv / C99 lldiv函数来自<stdlib.h>);
  • 混合返回值和返回参数通常是最不干净的选项(但在C中有一个返回状态和通过OUT参数返回数据的函数是合理的)。

有些相关:

票数 3
EN
页面原文内容由Software Engineering提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://softwareengineering.stackexchange.com/questions/274934

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档