热门角色不仅是灵感来源,更是你的效率助手。通过精挑细选的角色提示词,你可以快速生成高质量内容、提升创作灵感,并找到最契合你需求的解决方案。让创作更轻松,让价值更直接!
我们根据不同用户需求,持续更新角色库,让你总能找到合适的灵感入口。
生成符合标准的完整代码文档,包含函数描述及示例。
# Python函数文档
## 函数名称: `add`
**描述**
`add`函数是一个简单的加法函数,用于将两个数相加并返回结果。
---
## 参数
### 1. `a`
- **类型**: 任意数字类型(如`int`, `float`)
- **描述**: 第一个加数,表示要进行加法操作的其中一个数值。
### 2. `b`
- **类型**: 任意数字类型(如`int`, `float`)
- **描述**: 第二个加数,表示要进行加法操作的另一个数值。
---
## 返回值
- **类型**: 与输入参数相同,通常是`int`或`float`
- **描述**: 返回两个参数 `a` 和 `b` 相加的结果。
---
## 示例代码
以下是如何使用函数`add`的示例代码:
```python
# 示例 1: 常规整数相加
result = add(3, 5)
print(result) # 输出: 8
# 示例 2: 浮点数相加
result = add(2.5, 4.3)
print(result) # 输出: 6.8
# 示例 3: 整数和浮点数相加
result = add(7, 3.5)
print(result) # 输出: 10.5
result = add(0.1, 0.2)
print(result) # 输出: 0.30000000000000004
以下是根据Google Style生成的完整文档,符合函数描述、参数详情、返回值、以及示例代码的要求:
/**
* Multiplies two numbers and returns the result.
*
* This function takes in two numeric arguments, `a` and `b`,
* and returns the product of these two values. It is designed
* to perform simple multiplication operations.
*
* @param {number} a The first number to multiply.
* @param {number} b The second number to multiply.
* @return {number} The product of the two numbers.
*
* @example
* // Simple multiplication of two integers
* const result1 = multiply(3, 4);
* console.log(result1); // Output: 12
*
* // Multiplication involving a decimal
* const result2 = multiply(2.5, 4);
* console.log(result2); // Output: 10
*
* // Multiplication with negative numbers
* const result3 = multiply(-2, 3);
* console.log(result3); // Output: -6
*/
function multiply(a, b) {
return a * b;
}
此文档注释块详尽地描述了函数的用途和行为,包括参数说明(@param
)、返回值(@return
),并提供了若干常见使用情景的示例代码(@example
),完全符合Google Style文档注释的标准。
subtract
The subtract
method takes two integers as input and returns their difference. It performs a simple arithmetic operation by subtracting the second parameter from the first.
| Name | Type | Description |
|------|--------|--------------------------------------------------|
| a
| int
| The minuend. The number from which another is subtracted. |
| b
| int
| The subtrahend. The number to be subtracted. |
int
a
and b
.public class MathOperations {
public static void main(String[] args) {
MathOperations operations = new MathOperations();
// Example usage of the subtract method
int result = operations.subtract(10, 4);
// Print the result
System.out.println("The result of subtraction: " + result); // Output: 6
}
/**
* Subtract two integers and return the result.
* @param a The minuend
* @param b The subtrahend
* @return The result of a - b
*/
public int subtract(int a, int b) {
return a - b;
}
}
In the example above:
subtract
is called with arguments 10
and 4
.10 - 4
, which equals 6
.The result of subtraction: 6
.This documentation adheres to Markdown standards and provides all the necessary details for understanding and using the subtract
method effectively.
通过快速生成标准化代码文档,大幅减少手工编写时间,让更多时间专注于核心逻辑开发。
输出清晰易懂的函数说明和示例,帮助更高效地与开发团队沟通需求与技术实现。
轻松完成大批量代码文档整理工作,同时确保内容的准确性和格式统一性。
自动生成符合标准的代码文档,帮助开发者快速完成函数描述、参数说明、返回值详细信息以及示例代码的整理,提升开发效率与文档质量。
将模板生成的提示词复制粘贴到您常用的 Chat 应用(如 ChatGPT、Claude 等),即可直接对话使用,无需额外开发。适合个人快速体验和轻量使用场景。
把提示词模板转化为 API,您的程序可任意修改模板参数,通过接口直接调用,轻松实现自动化与批量处理。适合开发者集成与业务系统嵌入。
在 MCP client 中配置对应的 server 地址,让您的 AI 应用自动调用提示词模板。适合高级用户和团队协作,让提示词在不同 AI 工具间无缝衔接。
免费获取高级提示词-优惠即将到期