평론가로서 반년의 일을 지적하였다

반년 정도 나는 스클라임 팀에서 프로젝트를 진행했다
절차에 관해서는 자신이 진정 요청을 받아들여 논평 OK를 하면 합병 입장을 취했다.
댓글에서 멤버들에 대한 지적을 엄선해 6개로 정리했다.
루비로 개발된 것이기 때문에 루비에 가까운 부분이 있다고 생각하지만 기본적으로 어느 언어든 말할 수 있다.

1. 유명은 명사, 방법명은 동사

# NG
class RequestUser
  def email
    ...
  end
end

대상을 대상으로 하는 클래스 이름은 기본적으로 명사이고 방법 이름은 동사이다.
종류는 대상이고 물건이기 때문에 명사를 붙여야 한다.
방법은 어떤 동작을 하는 것이기 때문에 동사를 붙여라.

# OK
class UserRequests
  def send_email
    ...
  end
end

2. 변수 이름이 단수인지 여러 개인지 명확히 하기

# NG
user = User.all

User.all 사용자 테이블의 모든 데이터를 가져옵니다.복수해야 하는 사용자가 되돌아와야 하는데, 변수 이름user 때문에 단일 사용자입니까?이렇게 오해했어.
수조 등 여러 개의 데이터를 포함하는 변수의 이름은 복수형이고 단일할 때의 변수의 이름은 단수형이므로 반드시 명명해야 한다.

# OK
users = User.all

3. 판정 처리에서 반대를 피해야 한다

# NG
if !notSelected

음...selected의 반대??
코드를 볼 때 두 개의 처리를 추가하면 가독성이 떨어진다.나는 가능한 한 not와 un이 있는 변수 자체를 사용하지 않는 것이 좋다고 생각한다.

# OK
if selected

4. 나중에 수정할 것 더하기 #TODO

# NG
# ダミーデータを設定、あとで修正する
user_name = "cure_milky"

규격은 아직 결정되지 않았고, 때로는 가상 데이터를 먼저 설정할 수도 있다.평론을 남기는 것은 좋지만, 때로는 규격을 결정하는 것조차 잊어버리고 원래의 모양을 유지한다.
적어도 댓글TODO에 넣는 것이 좋다.IDE 등의 코드에 TODO 가 있으면 항상 목록에 표시되므로 쉽게 알아볼 수 있습니다.(그래도 때로는 잊어버리기도 한다.)

# OK
# TODO: ダミーデータを設定、あとで修正する
user_name = "cure_milky"

5. 양방향 버튼을 오른쪽으로, 음수 버튼을 왼쪽으로

NG

버튼은 모두 오른쪽에 있고 가벼운 타구는 똑같아 보이며 시각적 식별성이 떨어진다.
다음으로 전진하는 물건(긍정적인 물건)은 오른쪽에 놓고 되돌아오는 물건(소극적인 물건)은 왼쪽에 접근하는 것이 이해하기 쉽고 실수가 일어나지 않는다고 강조한다.
OK

6. 대화 상자가 간결하고 버튼의 표현도 이해하기 쉽다

NG

흔히 볼 수 있는 대화상자지만 문장이 좀 지루해서 내용을 이해하는 데 시간이 걸린다.만약 이런 대화상자라면, 아무 생각도 하지 않으려고'예'를 눌렀을 것이다.
대화에서 문장은 무엇을 해야 하는지, 단추의 표현도 무엇을 써야 하는지 간결하게 명확하게 해야 한다. 그러면 절대로 이해하기 쉽다.
OK