Pull to refresh

Использование тегов для разбора исходных текстов

Reading time1 min
Views967
Здравствуйте!

С помощью простого текста в комментариях и стандартных программ типа find/grep можно ускорить работу над унаследованным кодом.

Все уже привыкли к тегам (меткам), как к чему-то обыденному, хотя они стали широко использоваться в www относительно недавно.

Собственно, в программировании некоторое подобие тегов используется уже давно, но, к примеру, ctags, всё-таки не совсем то, о чём я хочу сказать.

Предположим, что у нас есть система, которая написана непонятно как, переменные называются совершенно от потолка, и всё это нужно понять, чтобы что-то исправить или добавить. Можно долго читать и записывать на бумажке основные моменты, но можно поступить по-другому.

В любом языке в начале тела функции или метода класса, или просто куска кода, в комментарий можно поместить одну строчку, в которой после слова TAGS: через запятую указать список используемых этим кодом понятий. Например, этот тег указывает, что данный кусок кода работает с адресом:

//TAGS: address

После нахождения всех мест, где используется адрес, и расстановки этого тега, с помощью find/grep в любой момент времени можно найти все места во всех файлах, в которых используется адрес.

Далее. Чтобы пометить код, который ответственен за работу с адресами (конечно, если он вообще есть), добавим перед этим кодом тег

//TAG OWNER: address

После этого, потратив какое-то время на вычитывание кода и расстановку тегов, всегда можно быстро найти все интересующие места. Таким образом, добавление всего двух типов тегов может сэкономить кучу времени. Можно придумать ещё несколько тегов, например, REFACTOR, но это уже на усмотрение читателя.
Tags:
Hubs:
Total votes 12: ↑12 and ↓0+12
Comments2

Articles