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

• NOTE: описание того, как работает код (когда это не самоочевидно).
• XXX: предупреждение о возможных подводных камнях, может использоваться как NOTE:XXX:.
• HACK: не очень хорошо написанный или искаженный код, чтобы обойти проблему / ошибку. Следует использовать как HACK:FIXME:.
• FIXME: это работает, вроде, но это может быть сделано лучше. (обычно код пишется в спешке, что требует переписывания).
• BUG: есть проблема здесь.
• TODO: нет проблем, но дополнительный код должен быть написан, как правило, когда вы пропускаете что-то.

по крайней мере, так меня учили об этих тегах. В основном первые два (NOTE и XXX) используются для получения информации и никаких действий не требуется. В то время как последние три (FIXME,BUG и TODO) требуют действий. HACK где-то посередине (и почти не используется Я думаю?).

некоторые заметки из июнь 2005 предложение по улучшению Python, которое было отклонено.

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

FIXME является предпочтительным написанием.
Солнце говорит, что XXX и FIXME несколько немного отличается, давая XXX более высокая степень серьезности.
Однако, с десятилетиями хаоса на эту тему, и слишком много миллионов
разработчики, на которых не повлияет солнце, легко по праву называют их синонимами.

---

бодрость духа начинается с,

этот PEP был отклонен. Хотя сообщество может быть заинтересовано,
нет никакого желания, чтобы стандартная библиотека соответствовала этому норматив.

...

Что Такое Кодовые Метки?

программисты широко используют специальные соглашения о разметке комментариев кода для обслуживания в качестве напоминаний о разделах кода, которые требуют более тщательного изучения или обзор. Примеры разметки включают FIXME,TODO,XXX, BUG, но там еще много в широком использовании в существующем программном обеспечении. Такие разметка отныне будет называться кодовые метки. Эти кодовые метки может появиться в код приложения, модульные тесты, скрипты, общие сведения документация, или везде, где подходит.

---

PEP-это интересное чтение.

посмотреть PEP350. Это объясняет все TODO,XXX etc. Я использую его каждый день, когда я не могу точно вспомнить, что означает один из тегов кода.

Я использую XXX потому что это легче, чем TODO.

XXX Это для того, когда вы в спешке и вернетесь к этому сами.

TODO - когда вы должны передать его кому-то еще.

наверное, это для случаев, которые вы не знаете, как справиться.
Проверьте это: представление списка операторов TODO / FIXME / XXX / HACK

alt текст http://editra-plugins.googlecode.com/svn/wiki/images/commentbrowser/cb_screenshot.PNG

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

• некрасиво
• страшно
• магия

или хуже.

(старый) соглашения кода Java:

используйте XXX в комментарии, чтобы отметить что-то, что является фиктивным, но работает. Использовать FIXME, чтобы отметить что-то, что является поддельным и сломанным.

XXX-это сокращение от caveat, которое немного отличается от NOTE, но очень похоже на HACK. Это может быть ошибка в сторонней библиотеке / код, который используется и код с // ХХХ: указывает на то, что это временное решение из-за ошибки в коде сторонних разработчиков или это может означать "осторожность" для кого-то просмотр / изменение кода, чтобы указать, почему что-то делается определенным образом, который в противном случае может показаться неправильным / неизящный на первый взгляд. HACK-это общий термин, означающий обходной путь для проблема, которая может присутствовать либо в вашей собственной базе кода, либо в сторонней библиотеке.

Я верю, в то время как FIXME для разработчиков, и HACK для сопровождающего, XXX для пользователей.

например, если вы игнорируете XXX и вызовите эту функцию в другом месте, не понимая, как она работает, может произойти что-то неожиданное, и человек, занимающийся этой проблемой, будет несчастен (по крайней мере, тот, кто добавил XXX так думает). Вы можете подумать, что проблема исчезнет, если вы просто не используете эту функцию.

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

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