CFScript에서 코드 힌트를 작성하는 두 가지 방법을 알고 있습니다. 나는 둘 사이에 기능적, 비 미학적 차이가 있는지, 그리고 모범 사례로 간주되는 것이 있는지 알고 싶다. CFScript로 작성할 때 힌팅 기법간에 미적인 차이점이 있습니까?
public function foo() hint="This function does something" {}
/**
* @hint This function does soemthing
*/
public function foo() {}
:
는내가 본 첫 번째 기술은 힌트를 추가하는 함수의 선언 위에 주석을 사용 하나를 사용하고 다른 하나는 사용하지 않으시겠습니까? 힌트를 원한다고 선언 할 수있는 근거가 있다면 접근 방식이 바뀌겠습니까?
주석 스타일/** * /과 인라인을 사용하는 사이에 인식 할 수있는 기능상의 차이점은 없습니다. 또한 힌트 만있는 것은 아닙니다. 모든 속성을 주석 또는 인라인에 배치 할 수 있습니다. 내가 아는 한, 그것은 순수하게 미적인 선택입니다.
는 명확히하기 :
/**
*@output false
*@returnType query
*/
public function foo() {}
public function foo() output='false' returntype='query' {}
와 같은 정확한 것은,의 JavaDoc 스타일, 찾고 조금 청소기 제 1 호 양식이다, 그러나 나는 거대한 개인적인 불만에 대한이 기능적 것이다 그것은 :
코드가 실행되는 방식을 변경해서는 안됩니다. 이제까지. 그것이 그들이 코멘트라고 불리는 이유입니다!
그런 이유로 나는 두 번째 스타일을 선호합니다. 깨끗하게 보이지는 않지만.
나는 당신이 폰트 크기로 거기에서 극적으로 조금씩 움직이고 있다고 생각한다. 그러나 각자 자신에게); –
그것은 내가 열정을 가지고있는 어떤 것이다. 코드 실행을 수정하는 주석은 근본적으로 나쁘다. –
어쩌면 맨 위에 조금 있습니다. 그것을 바꿨습니다. : P –
getComponentMetaData()을 사용하면 주석이 주석보다 우선합니다. 그렇지 않으면 기술적 인 차이가 없습니다. Adobe documentation on cfscript components 실제로이 주제에 꽤 좋다.
의견을 사용하는 것이 독자에게 의도를 전달하는 더 좋은 방법이라고 생각합니다. 이는 독자가 앞선 코드와 구별되기 때문입니다. 속성이 다른 코드와 정보를 나란히 배치하기 때문에 맞춤 설정 (예 : ORM에 대한 힌트)을 적용하는 것이 좋습니다.
Todd, 재미 있습니다 ... "public"이 함수의 첫 번째 단어 인 "public ="public "을 선언했습니다. 주석에 주석을 포함하는 용도는 무엇입니까? – Mohamad
아 ~ 네 - 죄송합니다 - 그럴 필요는 없습니다. 예를 들어 내 IDE에서 태그 기반 CFC를보고 있었지만 별 관심을 기울이지 않았습니다. 명확성을 위해 주석에서 제거하겠습니다. –
"query"반환 형식은 public과 function 키워드 사이에 있어야하며 returntype = – Henry