Проверить правильность написания кода

@MAN-TGA · Регистрация: 24.03.2013

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

Приветствую всех.Взялся изучать шарп.Ребят правильно ли я прокоментировал этот код? (Заранее спасибо):

@Sergey_B · 24.03.2013, 12:04

@Noob.net · 24.03.2013, 12:09

MAN-TGA, Правильно.
Ремарка:
- хорошо написанный код не нуждается в документации вида "что делают строчки"
- обычно пишут документацию в xml = "функционал метода\класса" + "возможные ошибки"
(читать MSDN + добровольцы
или кнопочку F12 на интерфейсах (MyClass : ICollection<T> <--- F12)
-исправляете название массива123 на randomArray например и название проекта обязательно адекватное

@MAN-TGA · 24.03.2013, 12:13 **[ТС]**

Дружище я прокомментил код для того чтобы спросить у вас правильно ли я думаюю. Т.е. правильный ли у меня ход мысли???

@Winhttp22 · 24.03.2013, 13:47

- хорошо написанный код не нуждается в документации вида "что делают строчки"

если у меня проект на несколько тысяч строчек, с многими функциями - разберешься без комментов, что где? на это потребуется время. а вот с комментами все легко разбирать.

@Vitall · 24.03.2013, 13:59

Winhttp22,

Сообщение от Winhttp22

если у меня проект на несколько тысяч строчек, с многими функциями - разберешься без комментов, что где? на это потребуется время. а вот с комментами все легко разбирать.

Думаю будет достаточно прокомментировать только функции .Закидывать весь код зелеными водорослями незачем ,если только конечно программа пишется не для перво-вордов

@Winhttp22 · 24.03.2013, 14:02

Vitall, ну я это и имел ввиду

@AceOfSpades · 24.03.2013, 21:24

Этот код вообще в комментариях не нуждается. Комментарии лучше писать к коду, который делает специфические вычисления, логику которых знаете только вы. И желательно писать xml-комментарии ко всем методам, особенно публичным.
А так, всё верно.

Psilon · 25.03.2013, 01:18

MAN-TGA, советую почитать Чистый код, хотя бы первые 2-3 главы, очень поможет в будущем

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

Комментарии не компенсируют
плохого кода
Одной из распространенных причин для написания комментариев является
низкое качество кода. Вы пишете модуль и видите, что код получился
запутанным и беспорядочным. Вы знаете, что разобраться в нем невозможно. Поэтому
вы говорите себе: «О, да это стоит прокомментировать!» Нет! Лучше исправьте
свой код!
Ясный и выразительный код с минимумом комментариев гораздо лучше
громоздкого, сложного кода с большим количеством комментариев. Не тратьте время
на написание комментариев, объясняющих созданную вами путаницу, — лучше
потратьте его на исправление.

А XML-документация, как я уже говорил, не самая лучшая штука. Лучше код, который самодокументируется и без них, а то по 4 строчки на комментарий как-то дофига, тем более, что ему свойственны все обычные недостатки...

@Yukikaze · 25.03.2013, 07:39

Не по теме:

Человек в комментариях написал то как он понимает код, и выложил на проверку, а вы демагогию развели по поводу обилия комментариев.
ЗЫ Никак не могу найти смайлик фейспалм, ну очень он подходит для данной ситуации

Psilon · 25.03.2013, 12:48

Yukikaze, один из последних

@Vitall · 25.03.2013, 13:19

Не по теме:

Сообщение от Psilon

Yukikaze, один из последних

Psilon,Ты прав ,для товарища Yukikaze последний смайл подойдет :ghide:
:D

@MAN-TGA · 25.03.2013, 13:20 **[ТС]**

Слава яйцам....Yukikaze ты меня один понял...Хотя может я и не так выразился.Именно это я и хотел, чтобы Вы по возможности сказали мне: правильно ли я понимаю суть.Ведь это и есть ООП.

@nio · 25.03.2013, 14:10

Не по теме:

Сообщение от Yukikaze

Никак не могу найти смайлик фейспалм

:facepalm:

Psilon · 25.03.2013, 15:26

MAN-TGA, если так ставить вопрос, то да, правильно прокомментировали, остальное вам уже сказали

@nio · 25.03.2013, 16:19

Комментарий модератора

Чтобы избежать двоякого чтения, название темы изменено

Psilon Master of Orion 6100 / 4956 / 905 Регистрация: 10.07.2011 Сообщений: 14,522 Записей в блоге: 5
	25.03.2013, 12:48	11
	Yukikaze, один из последних 0

@MAN-TGA 0 / 0 / 0 Регистрация: 24.03.2013 Сообщений: 5
		1
	Проверить правильность написания кода 24.03.2013, 12:00. Показов 3521. Ответов 15 Метки нет (Все метки) Приветствую всех.Взялся изучать шарп.Ребят правильно ли я прокоментировал этот код? (Заранее спасибо): Миниатюры 0

@Sergey_B 174 / 174 / 57 Регистрация: 08.01.2013 Сообщений: 335
	24.03.2013, 12:04	2
	0

@Noob.net Темная сторона .Net 592 / 489 / 39 Регистрация: 21.07.2012 Сообщений: 1,668
	24.03.2013, 12:09	3
	MAN-TGA, Правильно. Ремарка: - хорошо написанный код не нуждается в документации вида "что делают строчки" - обычно пишут документацию в xml = "функционал метода\класса" + "возможные ошибки" (читать MSDN + добровольцы или кнопочку F12 на интерфейсах (MyClass : ICollection<T> <--- F12) -исправляете название массива123 на randomArray например и название проекта обязательно адекватное 1

@MAN-TGA 0 / 0 / 0 Регистрация: 24.03.2013 Сообщений: 5
	24.03.2013, 12:13 [ТС]	4
	Дружище я прокомментил код для того чтобы спросить у вас правильно ли я думаюю. Т.е. правильный ли у меня ход мысли??? 0

@Winhttp22 169 / 132 / 29 Регистрация: 16.02.2013 Сообщений: 867
	24.03.2013, 13:47	5
	- хорошо написанный код не нуждается в документации вида "что делают строчки" если у меня проект на несколько тысяч строчек, с многими функциями - разберешься без комментов, что где? на это потребуется время. а вот с комментами все легко разбирать. 0

@Vitall 774 / 554 / 80 Регистрация: 03.07.2011 Сообщений: 1,020
	24.03.2013, 13:59	6
	Winhttp22, Сообщение от Winhttp22 если у меня проект на несколько тысяч строчек, с многими функциями - разберешься без комментов, что где? на это потребуется время. а вот с комментами все легко разбирать. Думаю будет достаточно прокомментировать только функции .Закидывать весь код зелеными водорослями незачем ,если только конечно программа пишется не для перво-вордов 0

@Winhttp22 169 / 132 / 29 Регистрация: 16.02.2013 Сообщений: 867
	24.03.2013, 14:02	7
	Vitall, ну я это и имел ввиду 0

@AceOfSpades 54 / 53 / 5 Регистрация: 14.08.2012 Сообщений: 252
	24.03.2013, 21:24	8
	Этот код вообще в комментариях не нуждается. Комментарии лучше писать к коду, который делает специфические вычисления, логику которых знаете только вы. И желательно писать xml-комментарии ко всем методам, особенно публичным. А так, всё верно. 0

Psilon Master of Orion 6100 / 4956 / 905 Регистрация: 10.07.2011 Сообщений: 14,522 Записей в блоге: 5
	25.03.2013, 01:18	9
	MAN-TGA, советую почитать Чистый код, хотя бы первые 2-3 главы, очень поможет в будущем Имена должны передавать намерения программиста. К выбору имен следует относиться серьезно. Чтобы выбрать хорошее имя, понадобится время, но экономия окупит затраты. Итак, следите за именами в своих программах и изменяйте их, если найдете более удачные варианты. Этим вы упростите жизнь каждому, кто читает ваш код (в том числе и себе самому). Имя переменной, функции или класса должно отвечать на все главные вопросы. Оно должно сообщить, почему эта переменная (и т. д.) существует, что она делает и как используется. Если имя требует дополнительных комментариев, значит, оно не передает намерений программиста. Комментарии не компенсируют плохого кода Одной из распространенных причин для написания комментариев является низкое качество кода. Вы пишете модуль и видите, что код получился запутанным и беспорядочным. Вы знаете, что разобраться в нем невозможно. Поэтому вы говорите себе: «О, да это стоит прокомментировать!» Нет! Лучше исправьте свой код! Ясный и выразительный код с минимумом комментариев гораздо лучше громоздкого, сложного кода с большим количеством комментариев. Не тратьте время на написание комментариев, объясняющих созданную вами путаницу, — лучше потратьте его на исправление. А XML-документация, как я уже говорил, не самая лучшая штука. Лучше код, который самодокументируется и без них, а то по 4 строчки на комментарий как-то дофига, тем более, что ему свойственны все обычные недостатки... 1

@Yukikaze
	25.03.2013, 07:39 #10
	Не по теме: Человек в комментариях написал то как он понимает код, и выложил на проверку, а вы демагогию развели по поводу обилия комментариев. ЗЫ Никак не могу найти смайлик фейспалм, ну очень он подходит для данной ситуации 1

	25.03.2013, 16:19

@Vitall
	25.03.2013, 13:19 #12
	Не по теме: Сообщение от Psilon Yukikaze, один из последних Psilon,Ты прав ,для товарища Yukikaze последний смайл подойдет :ghide: :D 1

@MAN-TGA 0 / 0 / 0 Регистрация: 24.03.2013 Сообщений: 5
	25.03.2013, 13:20 [ТС]	13
	Слава яйцам....Yukikaze ты меня один понял...Хотя может я и не так выразился.Именно это я и хотел, чтобы Вы по возможности сказали мне: правильно ли я понимаю суть.Ведь это и есть ООП. 0

@nio
	25.03.2013, 14:10 #14
	Не по теме: Сообщение от Yukikaze Никак не могу найти смайлик фейспалм :facepalm: 0

Psilon Master of Orion 6100 / 4956 / 905 Регистрация: 10.07.2011 Сообщений: 14,522 Записей в блоге: 5
	25.03.2013, 15:26	15
	MAN-TGA, если так ставить вопрос, то да, правильно прокомментировали, остальное вам уже сказали 0