변수명 기준

Amazon Q Developer는 사용자의 의도를 이해하고 변수 이름을 기반으로 제안을 제공합니다.

---

예시 #1

좋지 못한 함수 및 변수명

적절한 주석이나 변수 또는 함수 이름을 제공하지 않으면 Amazon Q Developer가 사용자의 의도를 이해할 수 없습니다.

일반적인 프롬프트

func f5(a,b sting) string {
}

위 함수명과 변수 이름은 함수, 변수를 설명하고 있지 않습니다. Amazon Q Developer가 함수의 의도를 유추하기 어려울 뿐만 아니라 다른 엔지니어도 코드를 이해하는 데 어려움을 겪을 것입니다.

Python 프롬프트

variables.py 라는 이름의 파일을 생성하고, 다음의 코드를 작성합니다.

def f5(x,y):

입력한 함수명은 함수를 설명하지 않습니다. Amazon Q Developer가 함수의 의도를 이해할 수 없기 때문에 도움이 되지 않는 제안을 받을 수도 있습니다.

Amazon Q Developer 제안

def f5(y,x):
    z = y + x

함수의 의도는 무엇이었나요? 더하기, 곱하기 또는 다른 것을 원하는 것인가요?

예시 #2

의미 있는 변수명

일반적인 프롬프트

• 변수 이름에 문제가 있습니다. 아무것도 입력할 필요가 없습니다.

Python 프롬프트

같은 파일에 다음을 입력하고

def f5(x,y):

그리고 의미 있는 변수명을 각각 입력합니다.

y_plus_x_squared
square_root_of_y_plus_x_squared

Amazon Q Developer 제안

def f6(y,x):
    y_plus_x_squared = y + x*x
    square_root_of_y_plus_x_squared = sqrt(y_plus_x_squared)

Amazon Q Developer는 변수의 의도를 이해하고 제안을 제공합니다.