Написание больших проектов

@polsok · Регистрация: 20.03.2011

Студворк — интернет-сервис помощи студентам

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

@m0nax · 15.11.2015, 22:09

по идее надо разделять ответственность классов, чтоб каждый делал что-то конкретное и понятное
правда тогда придется искать и вспоминать что делает класс и какой вообще класс, так что суть особо не изменится, но так модно

Добавлено через 3 минуты
один известный умник однажды выдвинул мысль - хороший метод не должен содержать больше 10 строк кода, вот живи с этим )

Psilon · 16.11.2015, 10:05

m0nax, если человек умник, он все равно может предлагать идиотские вещи. Например, Пенроуз и объективная редукция

@WinDev · 16.11.2015, 10:46

Если вам не удается с первого (или первых) раза (раз) писать более менее компактный код, и вы хотите спасти дело комментариями, то советую использовать xml комментарии. Как только дописали метод, поставьте строковый указатель на строку, которая непосредственно над методом и введите /// . VS сгенерирует вам xml комментарий по вашему методу, в нем вы можете подписать всю инфу о методе. И когда вы захотите обратиться к этому методу VS с помощью intellisense будет вам подсказывать, что делает метод, что возвращает и что за аргументы.

C#
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
class Car
    {
        public int Weight { get; set; }
        public string Model { get; set; }
        public string Brand { get; set; }
        public string Driver { get; set; }
 
        /// <summary>
        /// Основной конструктор класса с параметрами
        /// </summary>
        /// <param name="weight">Вес машины</param>
        /// <param name="model">Модель машины (например X6 для BMW)</param>
        /// <param name="brand">Марка машины (Например BMW)</param>
        /// <param name="driver">Имя водителя</param>
        public Car(int weight, string model, string brand, string driver)
        {
            Weight = weight;
            Model = model;
            Brand = brand;
            Driver = driver;
        }
 
    }

Добавлено через 1 минуту
Этот тип комментариев - стандарт для .NET. Именно по этому когда вы выбираете метод, вам выплывает куча подсказок

Новые блоги и статьи Все статьи Все блоги /
Символьное дифференцирование igorrr37 13.02.2026 / * Логарифм записывается как: (x-2)log(x^2+2) - означает логарифм (x^2+2) по основанию (x-2). Унарный минус обозначается как ! */ #include <iostream> #include <stack> #include <cctype>. . .	Камера Toupcam IUA500KMA Eddy_Em 12.02.2026 Т. к. у всяких "хикроботов" слишком уж мелкий пиксель, для подсмотра в ESPriF они вообще плохо годятся: уже 14 величину можно рассмотреть еле-еле лишь на экспозициях под 3 секунды (а то и больше),. . .	И ясному Солнцу zbw 12.02.2026 И ясному Солнцу, и светлой Луне. В мире покоя нет и люди не могут жить в тишине. А жить им немного лет.	«Знание-Сила» zbw 12.02.2026 «Знание-Сила» «Время-Деньги» «Деньги -Пуля»
SDL3 для Web (WebAssembly): Подключение Box2D v3, физика и отрисовка коллайдеров 8Observer8 12.02.2026 Содержание блога Box2D - это библиотека для 2D физики для анимаций и игр. С её помощью можно определять были ли коллизии между конкретными объектами и вызывать обработчики событий столкновения. . . .	SDL3 для Web (WebAssembly): Загрузка PNG с прозрачным фоном с помощью SDL_LoadPNG (без SDL3_image) 8Observer8 11.02.2026 Содержание блога Библиотека SDL3 содержит встроенные инструменты для базовой работы с изображениями - без использования библиотеки SDL3_image. Пошагово создадим проект для загрузки изображения. . .	SDL3 для Web (WebAssembly): Загрузка PNG с прозрачным фоном с помощью SDL3_image 8Observer8 10.02.2026 Содержание блога Библиотека SDL3_image содержит инструменты для расширенной работы с изображениями. Пошагово создадим проект для загрузки изображения формата PNG с альфа-каналом (с прозрачным. . .	Установка Qt-версии Lazarus IDE в Debian Trixie Xfce volvo 10.02.2026 В общем, достали меня глюки IDE Лазаруса, собранной с использованием набора виджетов Gtk2 (конкретно: если набирать текст в редакторе и вызвать подсказку через Ctrl+Space, то после закрытия окошка. . .

@polsok 7 / 6 / 6 Регистрация: 20.03.2011 Сообщений: 350

	Написание больших проектов 15.11.2015, 20:54. Показов 1150. Ответов 3 Метки нет (Все метки) Пишу проект, но возникла проблема: проект так разросся, что обычные комментарии в коде не спасают, очень часто приходится долго искать и вспоминать зачем этот метод даже с комментарием. Может кто поделится опытом, или подскажет литературу как писать и комментить большие проекты применительно к VS? 0

@m0nax 1274 / 975 / 113 Регистрация: 12.01.2010 Сообщений: 1,971
	15.11.2015, 22:09
	по идее надо разделять ответственность классов, чтоб каждый делал что-то конкретное и понятное правда тогда придется искать и вспоминать что делает класс и какой вообще класс, так что суть особо не изменится, но так модно Добавлено через 3 минуты один известный умник однажды выдвинул мысль - хороший метод не должен содержать больше 10 строк кода, вот живи с этим ) 0

Psilon Master of Orion 6102 / 4958 / 905 Регистрация: 10.07.2011 Сообщений: 14,522 Записей в блоге: 5
	16.11.2015, 10:05
	m0nax, если человек умник, он все равно может предлагать идиотские вещи. Например, Пенроуз и объективная редукция 0