如何在C函数文档中添加代码片段？

ttcibm8c 于 2023-01-12 发布在其他

关注(0)|答案(1)|浏览(106)

"你好"
如何在函数的文档注解中添加代码片段

/*
** This is my special function
** it is used like this
** ```ft_printf("I am %d years too early for marriage", -1)```             <<-- like this?
*
int        ft_printf(const char *fmt, ...);

我正在努力在我离开的工作中变得更善于沟通。我尽了最大的努力在互联网上寻找答案，只是不能很好地表达我自己，以获得我需要的答案。希望人类同胞能帮助我

来源：https://stackoverflow.com/questions/75050457/how-to-add-code-snippet-in-documentation-for-c-function

1条答案

按热度按时间

kg7wmglp1#

有很多方法可以做到这一点，所以这是非常主观的。一个常见的方法是为每个函数设置一个函数横幅，描述函数的用途、参数和返回值，例如：

///////////////////////////////////////////////////////////////////////////////
///
/// @par    Function Name
///         printf_str
///
/// @brief  Log a str to the debug stream.
///
/// @param  const char *        String to be output
///
/// @retval int        0 for success, otherwise an error code
///
////////////////////////////////////////////////////////////////////////////////
int printf_str( const char * str )

然后可以使用doxygen之类的工具从代码中生成文档。

赞(0）回复(0）举报 2023-01-12

我来回答

如何在C函数文档中添加代码片段？

1条答案

相关问题

热门标签

最新问答