chatgpt不能写代码了如何让chatgpt十分正确的帮咱们编写代码文档和单元测试

默认分类1年前 (2023)发布 admin

4,028 0 0

有多少次你专注于编程而忘记了写函数、方法、类的非常简单的代码文档？我不是在问单元测试.直到我发现可以做到这一点:

除了代码文档，它在编写单元测试方面也做得很好。此外，在最后，我可以要求他为其他想使用我的代码的贡献者生成一个用户友好的文档。在这篇文章中，我将告诉你如何使用来写：

写代码文档

写单元测试

生成你的代码的用户文档

让机器学习使软件开发和我们的软件开发人员的生活更容易。

如何帮助编写代码文档

听起来很简单，问问他就知道了。为了说明这一点，我们实际上需要一个代码例子，要求为我们写。

下面是它写的代码：

// This code generates a random number between 1 and 10
function getRandomNumber() {
  return Math.floor(Math.random() * 10) + 1;
}
// This function checks if a number is even
function isEven(number) {
  return number % 2 === 0;
}
// This function doubles a number
function doubleNumber(number) {
  return number * 2;
}
// This function logs the result of doubling a random even number
function logDoubleOfRandomEven() {
  const randomNumber = getRandomNumber();
  if (isEven(randomNumber)) {
    const doubledNumber = doubleNumber(randomNumber);
    console.log(`The double of ${randomNumber} is ${doubledNumber}`);
  } else {
    console.log(`${randomNumber} is not even. Cannot double it.`);
  }
}
// Call the function to log the result of doubling a random even number
logDoubleOfRandomEven();

一些非常简单的函数，没有什么代码文档让我们了解发生了什么事。，困难的部分已经完成了! 让我们来看看有趣的部分! 我们可以打开的聊天记录，很好地命令他：

为这段代码添加jsDoc，并确保包含代码标签,包括你想要的代码，如下面的截图所示，并在下面留下一些空间来做:

我使用了确保你包括代码标签，因为它有时会在段落中返回代码，所以这告诉他要在代码块中包括代码。你试过了吗？这是我的结果：

/**
 * Generates a random number between 1 and 10.
 *
 * @returns {number} A random number between 1 and 10.
 */
function getRandomNumber() {
  return Math.floor(Math.random() * 10) + 1;
}
/**
 * Checks if a number is even.
 *
 * @param {number} number - The number to check.
 * @returns {boolean} true if the number is even, false otherwise.
 */
function isEven(number) {
  return number % 2 === 0;
}
/**
 * Doubles a number.
 *
 * @param {number} number - The number to double.
 * @returns {number} The double of the input number.
 */
function doubleNumber(number) {
  return number * 2;
}
/**
 * Logs the result of doubling a random even number.
 */
function logDoubleOfRandomEven() {
  const randomNumber = getRandomNumber();
  if (isEven(randomNumber)) {
    const doubledNumber = doubleNumber(randomNumber);
    console.log(`The double of ${randomNumber} is ${doubledNumber}`);
  } else {
    console.log(`${randomNumber} is not even. Cannot double it.`);
  }
}
// Call the function to log the result of doubling a random even number
logDoubleOfRandomEven();

现在你没有借口不把你的代码写成大师的样子了很好，是吧？

用编写更好的单元测试

现在，一旦我们记录了我们的代码，是时候进一步提高代码质量并添加一些单元测试了。我们再次去聊天，并要求：

使用jest编写单元测试

chatgpt不能写代码了如何让chatgpt十分正确的帮咱们编写代码文档和单元测试

你不需要再包含代码了，它很聪明，明白自己必须为以前的代码写单元测试。只要确保你一直在同一个聊天室里问它，一直如此

这里是我们令人敬畏的单元测试：

const {
  getRandomNumber,
  isEven,
  doubleNumber,
  logDoubleOfRandomEven,
} = require('./example');
describe('getRandomNumber', () => {
  test('should generate a number between 1 and 10', () => {
    const randomNumber = getRandomNumber();
    expect(randomNumber).toBeGreaterThanOrEqual(1);
    expect(randomNumber).toBeLessThanOrEqual(10);
  });
});
describe('isEven', () => {
  test('should return true for an even number', () => {
    const evenNumber = 2;
    expect(isEven(evenNumber)).toBe(true);
  });
  test('should return false for an odd number', () => {
    const oddNumber = 3;
    expect(isEven(oddNumber)).toBe(false);
  });
});
describe('doubleNumber', () => {
  test('should double a number', () => {
    const number = 3;
    expect(doubleNumber(number)).toBe(6);
  });
});
describe('logDoubleOfRandomEven', () => {
  test('should log the double of a random even number', () => {
    const consoleSpy = jest.spyOn(console, 'log');
    const mockedRandomNumber = 4;
    const expectedOutput = `The double of ${mockedRandomNumber} is ${doubleNumber(mockedRandomNumber)}`;
    jest.spyOn(global.Math, 'random').mockReturnValueOnce(mockedRandomNumber / 10);
    logDoubleOfRandomEven();
    expect(consoleSpy).toHaveBeenCalledWith(expectedOutput);
    consoleSpy.mockRestore();
  });
  test('should log an error message if the random number generated is not even', () => {
    const consoleSpy = jest.spyOn(console, 'log');
    const mockedRandomNumber = 3;
    const expectedOutput = `${mockedRandomNumber} is not even. Cannot double it.`;
    jest.spyOn(global.Math, 'random').mockReturnValueOnce(mockedRandomNumber / 10);
    logDoubleOfRandomEven();
    expect(consoleSpy).toHaveBeenCalledWith(expectedOutput);
    consoleSpy.mockRestore();
  });
});