Лекции по предмету «Программное обеспечение информационно-измерительных процессов» для студентов специальности 5B071600 «Приборостроение»
жүктеу/скачать 0,67 Mb.
|
Конспект лекции-ПО ИИП 2014Ru
- Бұл бет үшін навигация:
- Правила именования объектов программы
- Документация в исходном коде
| Понятие стиля программы. Программирование - это мощное средство самовыражения с помощью компьютера. Подобно художнику, создавшему прекрасную картину, программист, завершивший разработку программы, часто испытывает чувство гордости за свою работу. Программирование может также придать вам уверенность в себе – ведь компьютер послушно выполняет ваши команды. Однако произведение художника бесполезно, если другие люди не имеют возможности насладиться им. Как и художник, переносящий свои мысли и чувства на полотно, программист вкладывает в код программы свои идеи. Однако помните: программа является не только средством управления компьютером, но и способом сообщения ваших идей другим людям. Программист объясняет принципы работы исходного кода путем включения в него своих комментариев.
С точки зрения технологичности хорошим считается стиль оформления программы, облегчающий её восприятие, как самим автором, так и другими программистами, которым, возможно придётся её проверять или модифицировать. «Помните программы читаются людьми», призывал Д. Ван Тассел, автор одной из известных монографий, посвященной проблемам программирования. Именно исходя из того, что любую программу, неоднократно придется просматривать, следует придерживаться хорошего стиля написания программ. Стиль оформления программы включает: правила именования объектов программы (переменных, функций, типов, данных и т.п.); правила оформления модулей; стиль оформления текстов модулей. Правила именования объектов программы. При выборе имен программных объектов следует придерживаться следующих правил: Имя объекта должно соответствовать его содержанию, например: MaxItem – максимальный элемент; NextItem – следующий элемент: Документация в исходном коде: 1. Каждая программа должна начинаться с комментария, содержащего имя и фамилию программиста, назначение программы, номер версии и дату создания. 2. Каждая подпрограмма должна начинаться с комментария, кратко описывающего назначение подпрограммы. Специальные исследования и практика программирования показывают, что общее описание, приведенное в начале подпрограммы, гораздо полезнее комментариев, разбросанных по коду. Комментарии должны описывать, что делает код, а не как он это делает. Отслеживая код, программист сам увидит, как он работает. 3. В исходном коде весьма полезны пустые строки, обозначающие разбивку программы на разделы. 4. Если назначение оператора, или группы операторов трудно понять из исходного кода, то он должен быть снабжен кратким комментарием. Однако описывать отдельные операторы следует как можно реже. Обычно эффективность таких комментариев невелика. Если комментарий описывает то, что несложно увидеть из кода, он даже затруднит чтение кода. Если такой комментарий все же необходим, располагайте его в начале блока, чтобы не разрывать структуру программы. 5. Имена переменных и подпрограмм должны быть информативными, т.е. такими, чтобы, Глядя на них, другой программист мог догадаться о назначении переменной или подпрограммы. Плохо подобранное имя, дезориентирующее читателя, даже хуже, чем неинформативное имя, например Х или А. Имена переменных должны состоять из букв нижнего регистра, кроме букв, с которых начинается второе или последующие слова, входящие в имя, например taxRate или numberOfCars. Имена подпрограмм должны начинаться с буквы верхнего регистра. 6. Имена объектов, свойств и методов должны начинаться с букв верхнего регистра. 7. Имя каждого компонента должно начинаться с префикса, состоящего из трех букв нижнего регистра и обозначающего тип компонента. Например, имя формы содержит префикс frm, поля ввода - edt, а кнопки - btn. Буквы после префикса описывают назначение или содержимое компонента. Например, поле ввода edtLastName содержит фамилию. жүктеу/скачать 0,67 Mb. Достарыңызбен бөлісу:
|