Как сделать комментарий в delphi
Комментарии к коду
Вложения
 | код.txt (3.7 Кб, 10 просмотров) |
Комментарии к коду
Помогите написать комментарии к коду. Шифрование DES unit DES; interface Uses Windows.
Комментарии к коду
Здравствуйте. Можете пожалуйста добавить комментарии к данному коду? Что значит Sender as TShape и.
Нужны комментарии к коду.
program otcht; type otch=record grupp:string; pred:string; kol:integer; pt:integer;.
Нужны комментарии к коду
treeview1.Items.Item.Selected:=true ; Sleep(1500); CreateSemaphore(nil,0,1,’compdevice’);.
Вложения
| код.txt (8.2 Кб, 11 просмотров) |
Добавлено через 1 минуту
спасибо огромное за код и комментарии) обязательно буду обращаться к Вам еще)
Вложения
 | Новая папка.rar (189.2 Кб, 1 просмотров) |
Вложения
| Новая папка.rar (200.0 Кб, 2 просмотров) |
Вложения
 | Test.zip (232.5 Кб, 4 просмотров) |
Вложения
| test.rar (201.9 Кб, 3 просмотров) |
Заказываю контрольные, курсовые, дипломные и любые другие студенческие работы здесь.
Написать комментарии к коду
Опишите какая строчка что выполняет ( не по блокам а именно по строчкам желательно) Магический.
Дайте комментарии к коду
unit UnitMainForm; interface uses Windows, Messages, SysUtils, Variants, Classes.
Калькулятор (нужны комментарии к коду)
Не могу понять алгоритм программы, скачал в интернете калькулятор, но не могу понять как работает.
Документирование кода в Delphi XE2.
Релиз RD Studio XE2 принес нам довольно много новинок на рассмотрение и проверку работоспособности/важности/необходимости которых у нас, видимо, уйдет весь промежуток времени до релиза XE3. Нововведения типа платформы Firemonkey или механизма LiveBindings сейчас на слуху у многих. Но не стоит забывать и про такие, пусть и не сильно заметные, но тем не менее полезные нововведения как, например, инструмент Documentation Insight. Про нечто подобное этому инструменту я говорил не далее как 27 апреля 2010 года в статье для конкурса на DelphiFeeds.ru, тема которого тогда была “Чего не хватает в Delphi?” И вот моя “хотелка” сбылась – в Delphi XE2 появился довольно удобный инструмент для создания и просмотра документации исходного кода.
Вначале небольшое введение в документирование кода в Delphi.
Документирование кода в Delphi.
Если не рассматривать всякого рода сторонние инструменты для создания документации к вашим исходникам, например, Doc-O-Matic, PasDoc и т.д., то “из коробки” нам остается создание документации на основе XML. Смысл такого документирования заключается в следующем: над элементом код, которые необходимо отразить в документации (класс, метод, переменная и т.д.) помещается специальный блок, каждая строка которого начинается с тройного слэша (///). В этом блоке располагаются XML-теги, содержащие какую-либо информацию по элементу (описание, значения переменных, ссылки на другие разделы документации и т.д.). Например, так можно сделать небольшой описание для класса формы:
На текущий момент, в Delphi XE2 используются следующие XML-теги для формирования документации:
Documentation Insight в Delphi XE2
Создание HTML-документации проекта
Как я говорил выше, на основе нашей XML-разметки для документации исходника можно также генерировать и HTML-справку. Сделать это довольно просто, используя инструмент Model View.
Алгоритм создания HTML-документации в этом случае может быть таким:
1. Создаем необходимые описания классов и методов в исходнике
2. В Project Manager переключаемся на вкладку Model View и соглашаемся включить поддержку моделирования.
3. В открывшемся окне выбираем наш проект и жмем Ok:
Теперь вкладка Model View будет выглядеть так:
4. Жмем в окне Model View правую кнопку мыши и в меню выбираем Generate Documentation:
5. В новом окне выбираем путь к документации, необходимые опции и жмем Ok:
В результате в выбраной директории будут сформированы необходимые файлы HTML-документации, которую можно будет просмотреть в браузере. Выглядеть справка по умолчанию будет так:
Конечно, использовать инструмент моделирования исключительно для того, чтобы сгенерировать HTML-справку – это крайне нерационально, т.к. этот инструмент имеет на порядок больше полезных функций и заслуживает отдельного внимания, но приведенный выше способ создания документации наиболее простой.
Что же касается самой HTML-справки, которую генерирует инструмент Delphi, то тут я, прямо скажу, не в восторге. По сравнению с тем же Doc-O-Matic документация содержит много лишнего, да и графика страдает. Поэтому этим способом создания HTML-документации я в принципе не пользуюсь. А вот Modeling периодически использую, особенно, когда в руки попадает чужой код, но это уже совсем другая история…
В заключение скажу, что новый инструмент Documentation Insight мне понравился даже включая во внимания его урезанную версию. Вполне работоспособный и удобный инструмент для документирования кода. Если разживусь на лишний рубль (а точнее 3к рублей) может даже и платную версию как-нибудь приобрету, если возникнет острая необходимость получить дополнительные “плюшки” для работы, но это всё мечты.
Как Вам новый инструмент? Планируете использовать его в дальнейшей работе?
Основы рефакторинга в Delphi XE.
Собственно, как и говорил в прошлом посте, на данный момент при появлении свободного времени я изучаю возможности рефакторинга в Delphi XE. Этот пост, как и пост по Git, является чем-то вроде моей онлайн-шпаргалки и, думаю, что будет полезен тем, кто хочет узнать в общих чертах, что предлагает нам Delphi XE в плане рефакторинга наших с Вами проектов.
Прежде всего стоит определиться с тем, что такое рефакторинг в принципе. В принципе, на данный момент, я понимаю под словом “refactoring” улучшение кода программы с целью его (кода) наилучшего понимания. Можно это определение корректировать, уточнять, но суть останется та же – улучшение.
Введение
Зачем нам с Вами “заморачиваться” над рефакторингом, улучшением понимания кода и т.д.? Конечно, если программа пишется “на раз” – написал и забыл, то да, не стоит даже и лезть в рефакторинг. Можно даже написать программу, собрать exe-шник, раздать/продать, а все исходники удалить, чтоб не дай боже руки не потянулись разбирать через год весь этот мусор. Однако, если предполагается, что Ваш проект будет жить и развиваться далее, то рефакторинг просто жизненно необходим. И вне зависимости от того знали ли Вы до сегодняшнего дня, что есть такое понятие или нет Вы использовали рефакторинг в своих проектах и не один раз.
Простой, но, думаю, что показательный пример для тех кто программирует недавно.
Вы пишете программу, скажем, простенький почтовый клиент. Первое с чего начинается обычно работа (исключая предварительную работу по продумыванию структуры, функций и т.д.) в Delphi – открыли IDE, создали проект, накидали на главную форму компонентов и начинаем писать обработчики при этом, естественно, большинство из нас забывает дать всем компонентам на форме осмысленные, понятные имена отличные от стандартных. К чему приведет такая работа, скажем, через месяц? Как минимум к тому, что будет очень затруднительно вспомнить для чего служит Memo1 или как называется правильно label куда выводится сообщение. Придётся сначала искать где вообще происходит присвоение значений, потом присваивать новое имя компоненту, а это в свою очередь приведет к тому, что при следующей компиляции Delphi выведет нам несметное количество Error’ов, как бы намекая, что такого компонента-то нету и т.д. и т.п. И будем горевать над кодом пол дня. Знакомая ситуация? Так вот для избегания таких ситуаций в том числе и предназначен рефакторинг – сделать Ваш код понятным на столько, чтобы и через 3 года Вы открыли код и вспомнили, что и к чему.
Между прочим, некоторые IDE, например, тот же Lazarus (если мне не изменяет память) способны по ходу написания кода и переименования компонентов на форме корректировать исходник и при этом не требуется устанавливать какие-либо дополнительные плагины – в Delphi XE переименование компонента через Object Inspector затрагивает только то, что на виду, т.е. – объявление поля в классе формы, объявление обработчика, а имя переменной внутри метода остается без изменений и в результате приводит к ошибкам компиляции. Но это так, к слову. И раз уж я начал описание рефакторинга с примера использования в программах непонятных названий компонентов и переменных, то с этой функции я и начну свой небольшой обзор.
Если заглянуть в меню Refactor, то можно увидеть следующий набор разнообразных опций:
Собственно, если перед этим почитать небольшую, но достаточно познавательную статью в Вики, то станет более менее понятно, что каждая из этих опций реализует один из методов рефакторинга. Посмотрим как работают эти функции на практике.
Rename – переименование
Как я сказал выше, если по имени переменной нельзя сразу понять для чего она предназначена, то на чтение кода приходится затрачивать дополнительное время. Когда проект небольшой – в 1000-1500 строк кода, то времени уходит не много, но если проект большой, то, иногда без бутылки пива и не разберешься, что и к чему работает.
Если при просмотре кода своей программы Вы столкнулись с такой ситуацией, то опция Rename (Shift+Ctrl+E) – это то, что Вы должны применить сразу же (иначе через полчаса опять все забудется :)).
Для примера работы этой функции я создал небольшое приложение в котором “забыл” присвоить кнопке осмысленное имя и оставил его по умолчанию – Button1, затем я написал обработчик onClick для этой кнопки, а также ещё в нескольких местах программы использовал переменную Button1, скажем, что-то типа: