ADN Open CIS
Сообщество программистов Autodesk в СНГ

Работа с макросами Комментирование кода

Предыдущие статьи

• Работа с макросами в Revit – Введение
• Работа с макросами в Revit – Первый макрос
• Работа с макросами в Revit – Выбор языка программирования
• Работа с макросами - Изучение Revit API
• Работа с макросами - Отладка
• Работа с макросами - Пошаговая отладка кода
• Работа с макросами - Использование контрольных точек

Хорошей практикой в программировании является комментирование кода. Подобные комментарии могут служить напоминанием для чего этот код нужен и почему он написан именно так, а не иначе.

В каждом языке программирования имеет свой синтаксис для обозначения комментариев. В C# комментарии код начинаются с двойного слэша (//) в начале строки. SharpDevelop подсвечивает комментарии зеленым цвтом.

Для комментирования блока кода можно также воспользоваться символами /*. Весь код, который находится между блоком /* и */ будет являться комментарием.

Комментарии также могут использоваться для предотвращения запуска определенного куска кода. Предположим, вы тестируете некий альтернативный алгоритм какой-то части макроса. Вы можете просто закомментировать «старую» часть кода.

Комментарии еще полезны при тестировании макроса. Если у вас возникает ошибка в одной части макроса, закомментируйте оставшуюся часть, скомпилируйте макрос и сделайте пошаговую отладку. Данный подход позволит сохранить вам много времени при отладке.

Источник: http://thebuildingcoder.typepad.com/blog/2015/10/rtc-classes-and-getting-started-with-revit-macros.html#22