Иногда, набирая что-то, относящееся к регистрозависимому языку программирования, я заканчиваю тем, что начинаю предложение с имени функции. Теперь правила английского языка гласят, что первое слово в предложении должно быть написано с большой буквы; хотя имя функции строчное Если вам интересно, что я могу сказать, что в результате первое слово будет именем функции, возьмите этот пример:
Ваша хреновая реализация сломана. fread должен вернуть количество прочитанных байтов.
Я понимаю, что могу изменить второй экземпляр fread на It, но я хочу знать лучший способ справиться с этим, кроме переписывания предложения. Должен ли я использовать заглавные буквы имени функции? Единственный способ, которым я хотел бы услышать «переписать предложение» в качестве ответа, - это если предложение, начинающееся с имени функции, нарушает какое-то английское правило, о котором я не знаю. Изменить: я действительно благодарю всех за эти ответы. Они изменили и улучшили мое понимание проблемы. Я многому научился из этого. Я очень удивлен, что я не подумал об этих простых, но хороших решениях.
Я действительно думаю, что моя позиция по чередованию предложения была слишком жесткой, и теперь я понимаю, что благодаря этим хорошим ответам, общее изменение предложения представляется наилучшим вариантом для решения этих случаев, будь то добавление скобок после функции или произнесение функции перед имя функции и, если доступно, используя форматирование для имени функции.
Ответы:
В типографии это обычно обрабатывается с использованием другого рендеринга, независимо от того, является ли это началом предложения, чтобы показать, что то, что бросается в глаза, это не просто слово в предложении, а особый объект.
Ваша
freadреализация не работает.freadНеобходимо вернуть, сколько байтов было прочитано.В зависимости от того, насколько формален документ, он может использовать один и тот же подход. В любом случае это устраняет проблему, которую вы идентифицируете, поэтому вы можете использовать ее только по этой причине.
В простом текстовом мире (как отмечалось несколькими в комментариях и других ответах) добавление скобок к именам функций немного помогает, но поскольку нам также нужно ссылаться на сущности, которые не заключают в скобки, это имеет только ограниченное значение. В целом, если не принимать соглашение об окружении текста специальными символами, такими как квадратные скобки и звездочки, в мире простого текста нет другого выбора, кроме как обойти проблему путем перестройки предложения.
источник
freadэто не слово; это символ, представляющий сущность. Это не подлежит грамматике.()или(...)обозначаю, что это функция. Но это не всегда работает, особенно при работе с переменными и тому подобным. Затем я оборачиваю имя`(галочкой), чтобы обозначить его код.Если существует абсолютное требование начинать каждое предложение с заглавной буквы, просто замените его
freadна «freadФункция», где бы оно ни начиналось.источник
Если у вас нет типографских средств для различения (как в другом ответе), и, возможно, даже если у вас есть, это может быть полезно, чтобы указать, что вы говорите о функции, используя parens:
Это помогает «объяснить», почему оно не пишется с заглавной буквы в начале второго предложения, а также помогает (в первом предложении) понять, почему собственное существительное (имя функции) там тоже не пишется с заглавной буквы . Поскольку (как собственно существительное) это, возможно, должно было быть.
(«возможно», потому что мы можем утверждать, является ли fread () родовым существительным или собственным).
В целом, использование паренов помогает мозгу читателя понять, почему появляются странные слова и чем они являются.
источник
fread()может быть оператором вызова. Или это может быть ссылка на перегруженную функцию без параметров.func_name()читается как «функция по имениfunc_name», независимо от того, имеет ли сама функция какие-либо параметры.f()что-то отличается отf. Почему бы не окружить имя каким-нибудь подходящим символом, например, «fread» в стиле markdown (это то, что я обычно делаю в сообщениях коммитов VCS)? Или просто (фред). Конечно, любая такая вещь должна выполняться последовательно, а не только для функций в начале предложения.Вы можете начать предложение с описания:
источник
Вы можете сравнить это со встроенной математикой в публикациях. Вы очень редко будете видеть предложения, начинающиеся с переменной или другой встроенной математики.
Таким образом, я заключаю, что вы должны избегать имен функций в начале предложения.
Может быть, этот вопрос содержит более подробную информацию: можно ли начинать предложение с греческой буквы (переменной)? ,
источник
Справочная страница Linux для fread (3) , на которую ссылались другие, является отличным примером четырех распространенных решений.
man, если ваша функция имеет справочную страницу, обратитесь к главе руководства в скобках. Так что "fread (3) нужно вернуть ..."Все четыре подхода будут сразу узнаваемы хакерами, и вы сможете выбрать тот, который соответствует вашему стилю дома или вашему личному голосу.
Как вы сказали, вы не можете полагаться на типографику, чтобы выделить название вашей функции. Синтаксис Markdown предназначен для создания удобочитаемой документации даже тогда, когда интерпретатор markdown недоступен, поэтому непременно окружите имя вашей функции парой обратных символов. (Это, я думаю, комбинация вариантов 2 и 3.)
Вариант 2 зависит от языка программирования. Например, документы Ruby и Smalltalk часто предшествуют именам методов экземпляра с помощью хеша, например #fread . Между тем Лисперс может предпочесть, чтобы имя функции было пустым, но поймет, если вы напишите вызов функции скелета, такой как (fread ...) или (fread) . Промойте и повторите для всех языков, которые вы документируете.
источник
Я собираюсь ответить только за конкретный пример:
Просто замените первую точку остановки (точка) точкой с запятой:
источник
Я знаю, что на этот вопрос уже дан ответ, и принятый ответ довольно хорош, но я просто хочу кое-что прояснить.
В правильной грамматике английского языка, суть заключается в следующем: иногда именам, имеющим собственное имя, дают имена, которые не начинаются с заглавной буквы, и в большинстве таких случаев они все равно привязаны к тому, что не пишутся с заглавной буквы, как «нормальные» имена капитализируется. В таких случаях, которые, безусловно, включают в себя большинство имен функций на языках С-спуска, вы абсолютно не пишете заглавными буквами даже в начале предложения. На самом деле, это плохая грамматика английского языка и орфография. На самом деле это часть того же принципа, почему правильно называть игровую консоль Sony «PlayStation», а не «Playstation».
Есть и другие случаи, в которых собственное существительное не должно начинаться с заглавной буквы по умолчанию, и все же это может быть (и должно быть) при использовании в начале предложения. Название языка brainfuck является примером этого. Функции на С-спущенных языках нет.
myFunc()иMyFunc()это две совершенно разные вещи в подобных языках, и начало предложения со слова «MyFunc ()» будет относиться только к последнему, а не к первому. В VB.NET, однако, это серая область, поскольку эти две функции будут одинаковыми на этом языке, хотя имена функций также сохранят схемы капитализации, заданные пользователем, на том или ином уровне.Кроме того, несмотря на то, что в этом случае английские правила изложены в камне, они, как правило, становятся немного туманными в таких вещах. Английский не был разработан с такими вещами в виду, поэтому для других вещей, как это, есть место для импровизации.
источник