Começando uma frase com um nome de função? [fechadas]

Ocasionalmente, ao digitar algo relacionado a uma linguagem de programação que diferencia maiúsculas de minúsculas, acabo iniciando uma frase com um nome de função. Agora, as regras do inglês afirmam que a primeira palavra em uma frase precisa ser maiúscula; o nome da função é minúsculo, no entanto. Se você está se perguntando o que eu poderia estar dizendo que resultaria na primeira palavra como um nome de função, veja este exemplo:

Sua implementação do fread está quebrada. O fread precisa retornar quantos bytes foram lidos.

Entendo que poderia mudar a segunda instância do pread para It, mas quero saber a melhor maneira de lidar com isso, além de reescrever a frase. Devo colocar em maiúscula o nome da função? A única maneira que eu gostaria de ouvir "reescrever a frase" como resposta é se iniciar a frase com um nome de função viola alguma regra em inglês que eu não conheço. Edit: Eu realmente agradeço a todos por essas respostas. Eles mudaram e melhoraram minha visão sobre o assunto. Eu aprendi um pouco com isso. Estou muito surpreso por não ter pensado nessas soluções simples, mas boas.

Eu acho que minha posição em alternar a frase era muito difícil e agora percebo, devido a essas boas respostas, que alterar a frase em geral parece ser a melhor opção para lidar com esses casos, seja adicionando parênteses após a função ou dizendo A função antes da nome da função e, se disponível, usando a formatação para o nome da função.

Na tipografia, isso geralmente é tratado usando uma renderização diferente, seja ou não o início de uma frase, para indicar que o que está chamando a atenção não é apenas uma palavra na frase, mas uma entidade especial.

Sua freadimplementação está quebrada. freadprecisa retornar quantos bytes foram lidos.

Dependendo da formalidade de um documento, ele pode adotar a mesma abordagem. De qualquer forma, isso elimina o problema identificado, portanto, você pode usá-lo apenas por esse motivo.

No mundo do texto sem formatação (como observado por vários nos comentários e outras respostas), acrescentar parênteses a nomes de funções ajuda um pouco, mas como também precisamos nos referir a entidades que não usam parênteses, isso tem apenas um valor limitado. Em geral, além de adotar uma convenção de cercar o texto com caracteres especiais como colchetes e asteriscos, no mundo do texto sem formatação há pouca opção a não ser contornar o problema reestruturando a frase.

Se houver um requisito absoluto para iniciar cada frase com um limite, basta substituir freadpor "A freadfunção" onde quer que ela comece.

Se você não possui meios tipográficos para distinguir (como em outra resposta), e talvez até o faça, pode ser útil indicar que você está falando sobre uma função usando parens:

Sua implementação fread () está quebrada. fread () precisa retornar quantos bytes foram lidos.

Isso ajuda a "explicar" por que ele não é capitalizado no início do segundo período, e também ajuda (na primeira frase) para entender por que o nome próprio (nome de uma função) não é capitalizada não quer . Desde (como um nome próprio), sem dúvida, deveria ter sido.

("indiscutivelmente" porque poderíamos argumentar se fread () é um substantivo genérico ou um nome próprio).

No geral, o uso de parênteses ajuda o cérebro do leitor a entender por que palavras estranhas aparecem e o que são.

Você pode iniciar a frase a partir da descrição:

A função fread[…]

O método fread[…]

A propriedade breadColor[…]

Você pode comparar isso com a matemática embutida nas publicações. Você raramente verá sentenças começando com uma variável ou outra matemática embutida.

Assim, concluo, você deve evitar nomes de funções no início de uma frase.

Talvez esta pergunta forneça mais detalhes: Tudo bem começar uma frase com uma letra grega (variável)? .

A página de manual do Linux para fread (3) que outros vincularam é um ótimo exemplo de quatro soluções comuns.

1. Comece sua frase com "A função foo" ou "A função foo". "A função fread precisa retornar ..." .
2. Marque o nome da função com caracteres extras de acordo com a convenção usada pela comunidade da linguagem de programação. No caso de C, um par de parênteses vazio, então "fread () precisa retornar ..." .
3. Use tipografia (negrito, caracteres de largura fixa ou itálico) para destacar o nome da função, como: " fread precisa retornar ..."
4. Nos sistemas utilizados man, se a sua função tiver uma página de manual, consulte o capítulo do manual entre parênteses. Então "fread (3) precisa retornar ..."

Todas as quatro abordagens serão instantaneamente reconhecíveis pelos hackers, e você poderá escolher uma que corresponda ao seu estilo de casa ou à sua voz pessoal.

Como você disse, você não pode confiar na tipografia para destacar o nome da sua função. A sintaxe do Markdown destina-se a tornar a documentação legível mesmo quando um intérprete do markdown não está disponível; portanto, envolva o nome da sua função por um par de backticks. (Acho que é uma combinação das opções 2 e 3.)

A opção 2 varia de acordo com a linguagem de programação. Por exemplo, os documentos Ruby e Smalltalk geralmente precedem os nomes dos métodos de instância com um hash, como #fread . Enquanto isso, Lispers pode preferir que o nome da função fique vazio, mas entenderá se você escrever uma chamada de função esquelética, como (fread ...) ou (fread) . Enxágue e repita para todos os idiomas documentados.

Vou apenas responder pelo exemplo específico dado:

Sua implementação do fread está quebrada. O fread precisa retornar quantos bytes foram lidos.

Basta substituir o primeiro ponto final (ponto final) por um ponto e vírgula:

Sua implementação do fread está quebrada; O fread precisa retornar quantos bytes foram lidos.

Sei que isso já foi respondido e a resposta aceita é muito boa, mas só quero esclarecer uma coisa.

Na gramática inglesa adequada, a linha inferior é a seguinte: Às vezes, nomes próprios recebem nomes que não começam com uma letra maiúscula e, na maioria dos casos, estão tão apegados a não serem capitalizados quanto os nomes próprios "normais" devem sendo capitalizado. Nesses casos - o que certamente incluiria a maioria dos nomes de funções em idiomas descendentes C - você absolutamente não coloca o nome em maiúscula, mesmo no início de uma frase. De fato, é uma má gramática e ortografia em inglês. Na verdade, isso faz parte do mesmo princípio do porquê é correto escrever o console de jogos da Sony "PlayStation", mas não "Playstation".

Há outros casos em que um nome próprio não deve ser capitalizado por padrão e, no entanto, pode ser (e deve ser) quando usado no início de uma frase. O nome da língua brainfuck é um exemplo disso. Funções em idiomas descendentes C não são. myFunc()e MyFunc()existem duas coisas totalmente diferentes em idiomas como esse, e iniciar uma frase com a palavra "MyFunc ()" se referirá apenas ao último, não ao primeiro. No VB.NET, porém, essa é uma área cinzenta, pois essas duas funções seriam a mesma coisa nesse idioma, embora os nomes de funções também retivessem esquemas de capitalização especificados pelo usuário, em algum nível ou outro.

Além disso, embora as regras em inglês sejam fundamentais neste caso, elas tendem a ficar meio nebulosas em relação a coisas como essa em regra. O inglês não foi projetado com coisas assim em mente; portanto, para outras coisas como essa, há espaço para improvisação.