Каково значение #XXX в комментариях к коду?

Используя start работы для меня:

@echo off
copy "C:\Remoting.config-Training" "C:\Remoting.config"
start C:\ThirdParty.exe

РЕДАКТИРОВАНИЕ: хорошо, взгляд более тесно, start, кажется, интерпретирует первый параметр как новый заголовок окна, если заключено в кавычки. Так, если необходимо заключить путь в кавычки к ThirdParty.exe, необходимо предоставить строку заголовка также.

Примеры:

:: Title not needed:
start C:\ThirdParty.exe

:: Title needed
start "Third Party App" "C:\Program Files\Vendor\ThirdParty.exe"
115
задан TylerH 13 December 2017 в 16:44
поделиться

5 ответов

XXX в комментарии обычно является хедз-апом. Это может быть:

  • Что-то, что реализовано не совсем правильно.
  • Что-то, что нужно исправить позже.
  • Выделение возможного проблемного места.
  • Что-то, в чем вы не уверены, вопрос.

Я часто предпочитаю более описательный тег, например FIXME или TODO или HACK . XXX часто используется как уловка для всего вышеперечисленного.

Поиск «XXX» в перекрестной ссылке кода FreeBSD является хорошим примером многих вариантов использования. Их тысячи ...

124
ответ дан 24 November 2019 в 02:23
поделиться

Заполнитель, обычно подразумевающий код, на который он ссылается:

  • Уродливый
  • Страшный
  • Магический

или хуже.

2
ответ дан 3 July 2019 в 05:56
поделиться

Я использую XXX , потому что набирать его проще, чем TODO .

XXX предназначен для тех, кто находится внутри поторопитесь и вернетесь к этому сами.

TODO - для случаев, когда вам нужно передать это кому-то другому.

6
ответ дан 24 November 2019 в 02:23
поделиться

Некоторые примечания из июня 2005 г. Предложение по усовершенствованию Python, которое было отклонено .

Выбор между FIXME и XXX является сложно.
XXX кажется более распространенным, но гораздо менее информативным.
Кроме того, XXX является полезным заполнителем в фрагменте кода
. имеющий неизвестное значение.

Таким образом, FIXME является предпочтительным написанием.
Sun сообщает, что XXX и FIXME немного отличаются, что дает XXX более высокий уровень серьезности.
Однако, учитывая десятилетия хаоса по этой теме и слишком много миллионов
developers who won't be influenced by Sun, it is easy to rightly call them synonyms.


The PEP Starts with,

This PEP has been rejected. While the community may be interested,
there is no desire to make the standard library conform to this standard.

...

What Are Codetags?

Programmers widely use ad-hoc code comment markup conventions to serve as reminders of sections of code that need closer inspection or review. Examples of markup include FIXME, TODO, XXX, BUG, but there many more in wide use in existing software. Such markup will henceforth be referred to as codetags. These codetags may show up in application code, unit tests, scripts, general documentation, or wherever suitable.


The PEP is an interesting read.

20
ответ дан 24 November 2019 в 02:23
поделиться
Другие вопросы по тегам:

Похожие вопросы: