1629295403-b876e2087bddebea4bc9666fb2377a02 (846199), страница 98
Текст из файла (страница 98)
В главе 18, "Эти исключительные исключения", более подробно рассказано о перекрытии T o S t r i n g ( ) .Класс S t u d e n t включает комментарии документирования, помеченные как / / / . Такое документирование делает код более понятным, в особенности если классы распределены по нескольким файлам, и может оказаться полезным для других программистов (дадаже и для самого автора исходного текста через некоторое время).
Об использованиитаких документирующих комментариев и генерации справочных файлов для ваших программ уже рассказывалось в главе 8, "Методы класса".Вы можете перекомпилировать вашу программу даже до того, как введетеисходный текст файла S t u d e n t . cs — после того, как введете исходныйтекст файлов U n i v e r s i t y . c s и P r o g r a m , c s . Это неплохая и д е я — инкрементная разработка программ. Перекомпилируйте и исправляйте вашупрограмму до тех пор, пока компилятор не перестанет выводить сообщенияоб ошибках или предупреждения. Поступайте так для каждого класса илидаже метода, пока не избавитесь от всех ошибок при компиляции.Исходный текст файла U n i v e r s i t y .
cs столь же прост, как и его предшественник:////V S I n t e r f а с е - файл U n i v e r s i t y . c sU n i v e r s i t y - простейший контейнерГлава 21. Использование интерфейса Visual Studioдлястудентов499usingSystem;usingSystem.Collections;namespaceVSInterface{///<summary>///University///-учебноезаведение</summary>publicclassUniversity{privatestringprivateSortedListpublicsName;students;University(string//СловарьsNarae){t h i s . s N a m e = sName;s t u d e n t s = new S o r t e d L i s t ( ) ;}/////////<summary>Enroll- добавить</summary>publicvoidстудентаEnroll(Studentвуниверситетstudent){students.Add(student.Name,student);}publicoverridestringToStringO{s t r i n g s = sNarae + " \ n " ;s += " С п и с о к с т у д е н т о в : " + " \ n " ;// Итерация по всем студентам у н и в е р с и т е т а с// использованием обычного перечислителяIEnumerator i t e r = students.GetEnumeratorО;while(iter.MoveNext()){object о = iter.Current;/ / Следующий п о д х о д н е р а б о т а е т ,потому что итератор// для S o r t e d L i s t возвращает записи словаря,которые// включают к а к с т у д е н т а ,так и ключ://// Student s t u d e n t =(Student)о;// // Р а б о т о с п о с о б е н следующий в а р и а н т ://(обратите внимание на преобразование типов)D i c t i o n a r y E n t r y de =( D i c t i o n a r y E n t r y ) о,Student student =(Student)de.Value;s += s t u d e n t .
T o S t r i n g ( ) + " \ n " ;}}}}returnS ;Д а н н ы й ф а й л у к а з ы в а е т , ч т о е г о с о д е р ж и м о е я в л я е т с я ч а с т ь ю п р о с т р а н с т в а именV S I n t e r f a c e . К л а с с U n i v e r s i t y с о с т о и т н е б о л е е ч е м и з и м е н и и отсортированнойколлекции студентов. М е т о д E n r o l l ( )добавляет объекты типа S t u d e n t в S o r t e d L i s t с и с п о л ь з о в а н и е м и м е н и с т у д е н т а в к а ч е с т в е к л ю ч а с о р т и р о в к и — д р у г и м и словами, студенты хранятся в списке в отсортированном порядке.500Часть VII. Дополнительные главыМетод U n i v e r s i t y .
T o S t r i n g ( ) выводит название университета, гимн и именавсех студентов. Он делает это путем создания итератора, метод M o v e N e x t () которогоприменяется для перехода от одного элемента списка к другому, получая каждый элемент посредством свойства C u r r e n t . Поскольку класс S o r t e d L i s t , в котором хранятся студенты, представляет собой словарь, итератор возвращает не сохраненные объекты, а записи из словаря (объекты класса D i c t i o n a r y E n t r y ) , содержащие объектвместе с ключом, применяемым для сортировки.
Обратите внимание на использованныепреобразования типов.Коллекции и их итерирование описаны в главах 15, "Обобщенное программирование", и 20, "Работа с коллекциями". Здесь вместо синтаксиса M o v e N e x t () можноприменить блок итератора, рассмотренный в предыдущей главе, а можно воспользоваться циклом f o r e a c h :foreach(DictionaryEntrydeinstudents){Student student =(Student)de.Value;s += s t u d e n t . T o S t r i n g ( ) + " \ n " ;}Как вы вскоре убедитесь, цикл f o r e a c h предпочтительнее.Преобразование классов в программуКлассы S t u d e n t и U n i v e r s i t y н е образуют программу.
Консольное приложениеначинается со статического метода M a i n ( ) . Этот метод может быть в любом классе,однако по умолчанию он находится в классе P r o g r a m .Содержимое исходного файла P r o g r a m , c s изменено следующим образом:// V S I n t e r f а с е - демонстрационная программа, состоящая из// нескольких к л а с с о в . Классы S t u d e n t и U n i v e r s i t y находятся// в своих собственных исходных ф а й л а х .// Файл P r o g r a m . c susingSystem;namespaceVSInterface{classProgram{staticvoidMain(string[]args){University university =new U n i v e r s i t y ( " И н с т и т у т случайных н а у к " ) ;university.Enroll(new Student("Dwayne",1234));university.Enroll(new Student("Mikey",1235));university.Enroll(new Student("Mark",1236));Console.WriteLine(university.ToString() ) ;Console.WriteLine();// Ожидаем п о д т в е р ж д е н и я п о л ь з о в а т е л яConsole.WriteLine("Нажмите <Enter> для " +"завершения программы...");Глава 21.
Использование интерфейса Visual Studio501Console.Read();}}}При компиляции программы файл проекта говорит Visual Studio о том, что в однупрограмму следует объединить все три ф а й л а — U n i v e r s i t y . c s , S t u d e n t . c sи Program. cs.При выполнении программы выводится простой (но отсортированный!) список студентов:Институт случайныхСписок студентов:Dwayne(1234)Mark(1236)Mikey(1235)PressEntertoнаукterminate...Программы в этой книге написаны так, чтобы максимально сэкономить бумагу. Дополнительные пустые строки опущены, код, который не представляет непосредственныйинтерес для рассматриваемой темы, зачастую тоже, а оставшийся в основном линейноорганизован.
Должен ли любой ваш код выглядеть таким образом?Далее приводится несколько рекомендаций по написанию кода, который легко читать(человеку), обновлять, сопровождать и тестировать, и который хорошо организованв концептуальном смысле.Используйте дополнительные пробелы и пустые строки. Избегайте излишнегосжатия кода, которое наблюдается в настоящей книге. Вот класс S t u d e n t , переписанный в более свободном формате://////V S I n t e r f а с е - файл S t u d e n t . c sStudent - моделирование студента,н а п и с а т ь с в о е имя#regionusingUsingкоторыйвс о с т о я н и и самDirectivesSystem;#endregionnamespaceUsingDirectivesVSInterface{III<summary>/// S t u d e n t - учащийся///</summary>publicclassStudentшколы{#region//502ИменаPrivateDataпеременныхFieldsначинаютсясострочнойбуквы,ноЧасть VII.
Дополнительные главы// слова внутри имени переменной//буквprivatestringsStudentName;private int nID;#endregion#regionPrivateспрописныхFieldsConstructors//Student//прописнойpublicDataначинаются-конструкторбуквы,икакStudent(stringимяиклассаначинаютсявсесловаsStudentName,внутриintсимениnID){this.sStudentNamethis.nID = nID;=sStudentName;}#endregion#regionConstructorsPublic///<summary>//////Name - имя</summary>public/////////stringMethodsandPropertiesучащегосяName{get{returnsStudentName;}}<summary>ToString - возвращает</summary>publicoverridestringимяиидентификаторToString(){returnString.Format("{o}({l})",sStudentName,nID);}#endregion}PublicMethodsandProperties}Используйте директивы Visual Studio # r e g i o n иttendregionдля отделенияразделов вашего кода. Это позволит сворачивать и скрывать разделы при работенад другими частями кода.
Нажмите <Ctrl+M>, а затем < C t r l + 0 > , чтобы переключиться между свернутым и развернутым состоянием. Давайте вашим разделамописательные имена, такие как показаны в приведенном листинге.Используйте X M L - к о м м е н т а р и и , начинающиеся с / / / . Данные символы позволяют Visual Studio применять их в механизме автозавершения, выводя комментарии как документацию по данному методу прямо в окне кода при вызове одногоиз ваших собственных методов. Механизм автозавершения рассматривался в главе 8, "Методы класса", и является одним из простейших способов получить справочную информацию о методе или классе — в том числе и по вашим собственным, если вы используете XML-комментарии.Глава 21.
Использование интерфейса Visual Studio503Вы можете также воспользоваться инструментом N D o c с открытым кодом( h t t p : / / n d o c . s o u r c e f o r g e . n e t ) и автоматически сгенерироватьпривлекательную документацию в стиле V i s u a l S t u d i o на основании вашихXML-комментариев.Комментируйте код, но делайте комментарии значимыми. Хорошийкомментарий рассказывает о ваших намерениях и назначении кода, а нео механике их реализации. Например, не пишите так:/ / Ц и к л п о м а с с и в у с т у д е н т о в с в ы з о в о м м е т о д а D i s p l a y для// каждого объекта типа S t u d e n t .Вместо этого достаточно написать://Выводинформацииостудентах.Посмотрите на имена методов или классов, которые собираетеськомментировать, и подумайте, нельзя ли их переименовать так, чтобы комментарии стали излишни. Метод D i s p l a y A l l S t u d e n t s () нетребует никаких комментариев.Используйте хорошие описывающие имена для переменных, методов,классов и прочих объектов.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
