2012-10-02 4 views
1

내 REST 웹 서비스 용 API 설명서를 작성 중입니다. 요청과 응답에는 몇 가지 열거 형이 포함되지만이를 설명하는 좋은 섹션 제목은 무엇입니까? "열거 형"이라는 제목은 프로그래밍 방식으로 들리는가요? 틀렸습니까?Api 문서 및 열거 의미

Gender 

Male - 1 
Female - 2 

Pool Team Status 

All - 1 
Active - 2 
Active and Paid - 3 

Registration Status 

All - 1 
Active - 2 
Active and Paid - 3 

Status 

All - 1 
Active - 2 
Active and Paid - 3 

답변

1

옵션, 대안 또는 다른 동의어로 참조 할 수 있습니다 (있는 경우).

그럼에도 불구하고 다른 프로그래머 용 문서를 작성한다고 가정 할 때 관리가 수행해야하는 것뿐만 아니라 열거 형 또는 열거 형은 청중에게 분명 할 것이므로 어떤 것이 좋을까요? 이루다.

+1

개인적으로 필자는 유형, 모드, 스타일, 옵션 및 플래그를 보았습니다. 열거 형은 많은 다른 것들을 나타낼 수 있으므로 컨텍스트를 아는 것이 유용 할 것입니다. – Traxxus

+0

플래그에 대해 생각해 보았습니다. –

+0

" "다음 옵션/필터를 사용하여 풀 팀 상태를 지정할 수 있습니다. - 전체 : ... - 활성 : ... - 활성 및 유료 : ... "여기서 ... 각 옵션/필터에 대한 설명으로 대체해야합니다. –