함수 이름으로 문장을 시작 하시겠습니까? [닫은]

대소 문자를 구분하는 프로그래밍 언어와 관련된 것을 입력하는 동안 함수 이름으로 문장을 시작하는 경우가 있습니다. 이제 영어 규칙은 문장의 첫 단어를 대문자로 표기해야한다고 명시하고 있습니다. 그러나 함수 이름은 소문자입니다. 첫 번째 단어가 함수 이름이 될 것이라는 말을 궁금해하는 경우 다음 예제를 사용하십시오.

스프레드 구현이 깨졌습니다. fread는 읽은 바이트 수를 리턴해야합니다.

나는 fread 의 두 번째 인스턴스 를 It으로 변경할 수 있음을 이해 하지만 문장을 다시 쓰는 것 외에 이것을 처리하는 가장 좋은 방법을 알고 싶습니다. 함수 이름을 대문자로 사용해야합니까? 답으로 "문 다시 쓰기"를 듣고 싶은 유일한 방법은 함수 이름으로 문장을 시작하면 내가 모르는 영어 규칙을 위반하는 것입니다. 편집 : 나는이 답변에 대해 모두에게 정말 감사합니다. 그들은 문제에 대한 나의 통찰력을 바꾸고 개선했습니다. 나는 이것으로부터 꽤 많은 것을 배웠다. 나는 간단하지만 좋은 해결책을 생각하지 않은 것에 매우 놀랐습니다.

나는 문장을 바꾸는 것에 대한 나의 입장이 너무 어렵다고 생각하고 이제는 문장의 전체를 변경하는 것이 함수 뒤에 괄호를 추가하거나 함수를 말하기 전에 문장을 변경하는 것이 최선의 선택이라고 생각합니다. 기능 이름 및 기능 이름 형식을 사용하여 사용 가능한 경우.

타이포그래피에서는 일반적으로 문장의 시작 여부에 관계없이 다른 렌더링을 사용하여 눈에 띄는 것이 문장의 단어가 아니라 특수한 엔티티임을 나타냅니다.

귀하의 fread구현은 나뉩니다. fread읽은 바이트 수를 반환해야합니다.

문서의 형식에 따라 동일한 접근 방식을 채택 할 수 있습니다. 어쨌든 식별 한 문제가 제거되므로 해당 이유로 만 사용할 수 있습니다.

평범한 텍스트 세계에서 (주석과 다른 답변에서 여러 사람이 지적한 것처럼) 함수 이름에 괄호를 추가하면 약간 도움이되지만 괄호를 사용하지 않는 엔터티도 참조해야하므로 값이 제한적입니다. 일반적으로 대괄호 및 별표와 같은 특수 문자로 텍스트를 둘러싼 규칙을 채택하지 않으면 일반 텍스트 세계에서는 문장을 재구성하여 문제를 회피 할 수있는 옵션이 거의 없습니다.

각 문장을 대문자로 시작해야하는 절대적인 요구 사항이있는 경우 문장을 시작할 때마다 fread" fread기능"으로 간단히 바꾸 십시오.

다른 답변에 따라 구별 할 수있는 활자체 수단이 없다면, 아마도 그렇게하더라도, parens를 사용하여 함수에 대해 이야기하고 있음을 나타내는 것이 유용 할 수 있습니다.

fread () 구현이 깨졌습니다. fread ()는 읽은 바이트 수를 리턴해야합니다.

이것은 왜 두 번째 문장의 시작 부분에 대문자로 표기되지 않은지를 "설명"하는 데 도움이되고, 또한 첫 번째 문장에서 적절한 명사 (함수 이름)가 대문자로 표기되지 않은 이유를 이해하는 데 도움이 됩니다 . (올바른 명사로서) 그것은 틀림없이 있어야했다.

(fread ()가 일반 명사인지 적절한 명사인지 논쟁 할 수 있기 때문에 "논쟁 적으로").

전반적으로, parens의 사용은 독자의 두뇌가 이상한 단어가 나타나는 이유와 그 단어가 무엇인지 이해하는 데 도움이됩니다.

설명에서 문장을 시작할 수 있습니다.

기능 fread[…]

방법 fread[…]

속성 breadColor[…]

이것을 출판물의 인라인 수학과 비교할 수 있습니다. 변수 나 다른 인라인 수학으로 시작하는 문장은 거의 볼 수 없습니다.

따라서 문장의 시작 부분에서 함수 이름을 피해야한다고 결론을 내립니다.

어쩌면이 질문은 더 자세한 내용을 제공 할 것입니다. 그리스 문자 (가변)로 문장을 시작해도 괜찮습니까? .

다른 사람들이 링크 한 fread (3)에 대한 Linux 매뉴얼 페이지 는 4 가지 일반적인 솔루션의 좋은 예입니다.

1. "The function foo"또는 "The foo function"으로 문장을 시작하십시오. "기능 fread를 반환해야합니다 ..." .
2. 프로그래밍 언어 커뮤니티에서 사용하는 규칙에 따라 함수 이름에 추가 문자를 표시하십시오. C, 괄호의 빈 쌍의 경우, 그래서 "FREAD는 () ... 반환해야" .
3. 타이포그래피 (굵게, 고정 너비 문자 또는 기울임 꼴)를 사용하여 다음과 같이 함수 이름을 강조 표시하십시오. " fread need to return ..."
4. 를 사용하는 시스템에서 man함수에 매뉴얼 페이지가있는 경우 괄호 안의 매뉴얼 장을 참조하십시오. 따라서 "fread (3)은 반환해야합니다 ..."

네 가지 방법 모두 해커가 즉시 인식 할 수 있으며, 집 스타일이나 개인 목소리에 맞는 방법을 선택할 수 있어야합니다.

말했듯이, 기능 명을 강조하기 위해 타이포그래피에 의존 할 수 없습니다. 마크 다운 구문은 마크 다운 인터프리터를 사용할 수없는 경우에도 읽을 수있는 문서를 작성하기위한 것이므로 함수 이름을 한 쌍의 백틱으로 묶어야합니다. (이것은 옵션 2와 3의 조합입니다.)

옵션 2는 프로그래밍 언어에 따라 다릅니다. 예를 들어 Ruby 및 Smalltalk 문서는 종종 #fread 와 같은 해시로 인스턴스 메소드 이름 앞에 옵니다 . 한편 Lispers는 함수 이름이없는 것을 선호하지만 (fread ...) 또는 (fread) 와 같은 스켈레톤 함수 호출을 작성하면 이해합니다 . 문서화 한 모든 언어에 대해 헹구고 반복하십시오.

주어진 특정 예에 대해서만 대답하려고합니다.

스프레드 구현이 깨졌습니다. fread는 읽은 바이트 수를 리턴해야합니다.

첫 번째 완전 정지 (마침표)를 세미콜론으로 바꾸십시오.

당신의 스프레드 구현이 깨졌습니다. fread는 읽은 바이트 수를 리턴해야합니다.

나는 이것이 이미 답변되었고, 받아 들여진 대답은 꽤 좋지만, 나는 무언가를 분명히하고 싶습니다.

적절한 영어 문법에서 결론은 다음과 같습니다. 때때로 적절한 명사에는 대문자로 시작하지 않는 이름이 주어지며, 대부분의 경우, "정상적인"명사로 대문자로 표기되지 않은 모든 이름이 붙습니다. 자본화되고 있습니다. 이러한 경우 (대부분 C 함수 언어로 된 대부분의 함수 이름을 포함 )는 문장의 시작 부분에서도 이름을 대문자로 사용 하지 않습니다 . 실제로, 영어 문법과 철자가 나쁜 것입니다. 이것은 실제로 왜 소니의 게임 콘솔 "PlayStation"의 철자가 올바른지 "Playstation"이 아닌 이유와 같은 원리의 일부입니다.

적절한 명사가 기본적으로 대문자로되어 있지 않은 경우도 있지만, 문장의 시작 부분에 사용될 때도있을 수 있습니다. 언어 brainfuck의 이름은 이것의 예입니다. C-descended 언어의 함수는 그렇지 않습니다. myFunc()그리고 MyFunc()두 가지 완전히 같은 언어의 여러 가지, 그리고 단어 "Func라고 ()"뿐만 아니라 이전에, 후자를 참조 것으로 문장을 시작. 그러나 VB.NET에서는이 두 함수가 해당 언어에서 동일한 것이기 때문에 회색 영역입니다. 함수 이름은 사용자 지정 대문자 표기법을 어느 정도 또는 다른 수준으로 유지하지만.

또한이 경우에는 영어 규칙이 결석으로 설정되어 있어도 규칙적으로 이와 같은 것들에 대해 흐릿한 경향이 있습니다. 영어는 이와 같은 것을 염두에두고 설계되지 않았으므로 다른 것들을 위해 즉흥을위한 여지가 있습니다.