英文:
How to add code-snippet in documentation for C function?
问题
你好
我如何在函数的文档注释中添加代码片段
/*
** 这是我的特殊函数
** 用法如下
** ```ft_printf("我离婚还早了%d年", -1)``` <<-- 像这样？
*/
int ft_printf(const char *fmt, ...);
我试图在工作中变得更有交流性。我已经尽力在互联网上找到答案，只是不能表达得足够清楚以获得所需的答案。希望一位人类同伴会帮助。
英文:
Hello there
How I can add a code-snippet inside a documentation comment for a function
/*
** 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, ...);
I am trying to become more communicative in the work i leave behind.
I did my best to find answers on the internet, just couldn't express my self well enough to get the answers i needed. hopefully a fellow human well help
答案1
得分: 1
有许多方法可以做到这一点，因此这是非常主观的。一种常见的方法是为每个函数创建一个函数标语，描述函数的目的、参数和返回值，例如：
///////////////////////////////////////////////////////////////////////////////
///
/// @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这样的工具从您的代码生成文档。
英文:
There are lots of ways to do it, so this is very subjective. One common way is to have a function banner for each function that describes the purpose of the function, its parameters, and the return value, e.g.
///////////////////////////////////////////////////////////////////////////////
///
/// @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 )
You can then use tools like doxygen to generate documentation from your code.
通过集体智慧和协作来改善编程学习和解决问题的方式。致力于成为全球开发者共同参与的知识库，让每个人都能够通过互相帮助和分享经验来进步。
评论