Есть ли Общепринятые Стандарты по написанию программы?

← →
Abcdef123 (2008-08-13 07:07) [0]

Есть ли такие в природе, если есть, то дайте ссылочку, плз, где почитать.
Если точнее меня интересует есть ли общепринятые правила где в программном коде надо писать комментарий: справа от строки кода или наверху?
Я знаю, это многие скажут - несущественно, и я до сих пор так думаю (используя оба варианта в зависимости от длины текста комментария), но возник чисто принципиальный спор о существовании международного стандарта, кое-кто считает, что надо писать комментарии над строкой кода ( а не справа).
Всем откликнувшимся буду признательна.

← →
KilkennyCat © (2008-08-13 07:41) [1]

А с чего Вы взяли, что стандарт один? ;)

← →
Anatoly Podgoretsky © (2008-08-13 08:58) [2]

Писать можно и внутри.

← →
Ru © (2008-08-13 09:06) [3]

Разве что писать читабельно ...
Можно на sf порыться посмотреть как там люди код оформляют.
И есть такое понятие "внутренние" или "корпоративные" стандарты :)
В рамках своей фирмы сами себе стандарт выдумываете.
Видел человека, который писал максимально не читабельно - чтоб идею не спёрли.
Я потом две недели код в читабельный вид приводил.

← →
oldman © (2008-08-13 09:15) [4]

Писать можно и так, и так.
Зависит от коментария.

//функция проверки значения
procedure MyProc1()

bla bla bla

i:=0; // обнуляем флаг

← →
Medbe}I{onok XML © (2008-08-13 09:52) [5]

писать надо так, чтобы небыло мучительно больно ......

← →
Anatoly Podgoretsky © (2008-08-13 09:55) [6]

А не больно будет, если не будут бить.

← →
Abcdef123 (2008-08-13 10:16) [7]

To KilkennyCat © (13.08.08 07:41) [1]
В том то и дело, что я так не считаю!

To Ru © [3]
1.Что такое sf?

Дополнительное пояснение на прочитанные комментарии.
Я полностью согласна с oldman, я так и пишу в зависимости от комментария, то есть использую оба варианта. Но просто некий программист -НЕ из России(и не из СССР) начал указывать, что вариант написания комментария справа - это не правильно, надо всегда писать на новой строке над кодом. Я начала возмущаться, с чего бы это такое правило, он сказал, что это общепринятые международные стандарты грамотных программистов, и ссылался на то чтоб я посомтрела как майкрософт оформляет программы или чтоб поискала и почитала правила написания комментариев. Где читать - не уточнял, видимо считает, что грамотные программеры уж точно должны знать где это. В общем, меня это задело, я не претендую на супер программиста, но чтоб уж носом иностранцы тыкали как правильно писать комментарий в программе - это уж слишком, тем более я думаю, что он не прав. Вот и хочется его в "спустить" на землю, чтоб не зарывался. Ну а чтоб ему доказать, что он не прав, мне надо бы найти реальные аргументы свой правоты. Вот и обратилась сюда за советом.

← →
oldman © (2008-08-13 10:19) [8]

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

А майкрософт - это общепринятые международные стандарты грамотных программистов?
Ни фига себе!

← →
Игорь Шевченко © (2008-08-13 10:20) [9]

> А майкрософт - это общепринятые международные стандарты
> грамотных программистов?

Да, один из стандартов.
Второй - Unix

← →
McSimm © (2008-08-13 10:22) [10]

надо срочно решать какой лучше

← →
MsGuns © (2008-08-13 10:46) [11]

>Abcdef123 (13.08.08 10:16) [7]
>Но просто некий программист -НЕ из России(и не из СССР) начал указывать, что вариант >написания комментария справа - это не правильно, надо всегда писать на новой строке над кодом.

Если этот "некий" програмист является Вашим руководителем и объясняет вам принятые в конторе стандарты, Вам нужно их не обсуждать, а просто следовать им. Ибо в чужой монастырь со своим уставом не ходят.
Если нет, спокойно объясните ему что Вы работаете строго в соответствии со стандартами, принятыми здесь и он, скорее всего, угомонится. Во всяком случае свою критику перенессет с Вас на того, кто писАл этот стандарт.
Если стандарта нет и Вы работаете (как и все остальные) как им удобно (привычно), то это уже предвестник бардака. Стандарт нужен обязательно. Хоть какой, но стандарт.

Главный принцип любого стандарта - это максимальная унификация и читабельность исходников проектов, цель которых во взаимозаменяемости исполнителей и сведение к минимуму затрат на разработку, отладку и внедрение проектов

← →
oldman © (2008-08-13 10:48) [12]

There are several ways to construct comments:

{ Text between a left brace and a right brace constitutes a comment. }
(* Text between a left-parenthesis-plus-asterisk and an asterisk-plus-right-parenthesis also constitutes a comment. *)
// Any text between a double-slash and the end of the line constitutes a comment.

Всегда думал, что // ставится в конце строки, а {} на отдельной строке

← →
Плохиш © (2008-08-13 10:49) [13]

> Abcdef123 (13.08.08 10:16) [7]

Тут эта... русская пословица есть "Не спорь с дураком, сам дураком окажешься".
Потребуй от него письменную инструкцию по оформлению исходных кодов, принятую в Вашей компании и прочитай там, как должны оформляться комментарии.

← →
MsGuns © (2008-08-13 10:52) [14]

>Плохиш © (13.08.08 10:49) [13]
>Тут эта... русская пословица есть "Не спорь с дураком, сам дураком окажешься".

Есть еще другая, нерусская:
Из двух спорящих один дурак, другой подлец :)

← →
Abcdef123 (2008-08-13 10:53) [15]

ну, вот, получается, что и у русских программистов нет согласия в этом вопросе :-)))

← →
MsGuns © (2008-08-13 10:56) [16]

Причем тут согласие ? Единство есть только в армии, где согласия, как известно, вовсе не требуется.
Во всем остальном мире правит полиморфизм :)

← →
Anatoly Podgoretsky © (2008-08-13 11:25) [17]

> Abcdef123 (13.08.2008 10:53:15) [15]

Откуда он возьмется? У каждого свои стандарты.
Но комментрий // вообще то не из Дельфи, а из Си, его просто в Дельфи приватизировали и данный комментарий как раз для размещения в конце строки еще называют его однострочный комментарий, а в других местах /* */, но можно и //, дело вкуса, можно и не по назначению использовать.

← →
Abcdef123 (2008-08-13 11:27) [18]

To MsGuns © (13.08.08 10:56) [11]
Нет, этот не русский программер - не руководитель, а новенький в компании. Программист он вроде сильный, но амбиции прут с первого дня. Ему неведома пословица в чужой монастырь со своим уставом не ходят. Он пытается свои представления представить так общепринятые мировые стандарты, а что мы тут вот сидим дураки, отсталые, и нам давно пора перестраиваться. А начальник человек нескандальный, просто не вступает в прения в подобных случаях, ему достаточно того, что этот программер умный специалист. А письменных указаний насчет внутреннего стандарта у нас нет, но все бывшие и нынешние программеры используют оба варианта. Ну а этому новенькому неймется, вот он решил не начальнику, а мне указать, что так писать комментарий неположено, выдавая собственное мнение за "международный стандарт".
Тему думаю пора закрыть, я полностью согласна с приведенной здесь пословицей "Не спорь с дураком, сам дураком окажешься". Я просто хотела услышать мнения насчет существования или отсутствия международных стандартов по этому вопросу. Из обсуждения я поняла, что таковых стандартов мирового уровня нет.
Всем спасибо!

← →
blackman © (2008-08-13 11:33) [19]

Вполне приличная статья
Стандарты написания исходного кода в Delphi
http://www.delphiplus.org/articles/delphi/source_code_standards/index.html

← →
Игорь Шевченко © (2008-08-13 11:44) [20]

> Из обсуждения я поняла, что таковых стандартов мирового
> уровня нет.

Если бы был стандарт мирового уровня, он бы давно был встроен в компилятор.

← →
Anatoly Podgoretsky © (2008-08-13 11:52) [21]

> Abcdef123 (13.08.2008 11:27:18) [18]

Может вам проще уволить его, что бы не разлагал коллектив, не устраивал склоки?

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

← →
oldman © (2008-08-13 11:52) [22]

> Игорь Шевченко © (13.08.08 11:44) [20]

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

А если это рабочие записи, которые будут уничтожены перед сдачей проекта?

← →
Плохиш © (2008-08-13 12:03) [23]

> Abcdef123 (13.08.08 11:27) [18]
> To MsGuns © (13.08.08 10:56) [11]
> Нет, этот не русский программер

Ну их, в первую очередь, учат молоть языком.

> новенький в компании. Программист он вроде сильный

Это он уже делами показал или только языком "намолол"?

← →
ketmar © (2008-08-13 12:16) [24]

>[22] oldman © (2008-08-13 11:52:00)
>Еще не хватало, чтобы компилятор мне указывал, где мне писать комменты!!!
а сейчас, по-твоему, не указывает? O_O

---
Do what thou wilt shall be the whole of the Law.

> ketmar (13.08.2008 12:16:24) [24]

Дельфи не указывает где, лишь бы не разбивались литералы, а вот некоторые продукты от МС убивают, не только комментарии диктует, но и остальной код, правда потихоньку отходят от подобной политики.

>[25] Anatoly Podgoretsky © (2008-08-13 12:22:00)
>Дельфи не указывает где, лишь бы не разбивались литералы
значит, уже указывает. кстати, если ставить каменты необычным образом, можно хорошо озадачить code completion.

---
Understanding is not required. Only obedience.

> Еще не хватало, чтобы компилятор мне указывал, где мне писать
> комменты!!!

В NET есть комментарии специального вида, на основе которых из кода проекта генерируется некое подобие документации. Мне эта идея нравится, и я согласен писать текст один раз, но понятным для системы образом, чтобы потом этот текст появился в документации, которую все равно потом приходится писать.

>Программист он вроде сильный

Лежа жмет стопятьдесят ?

> А письменных указаний насчет внутреннего стандарта у нас
> нет, но все бывшие и нынешние программеры используют оба
> варианта.

Сочувствую....
Как показала практика - нельзя работать над одним проектом нескольким прогерам при отсутсвии стандарта....
Помойму певое что всегда стоит сделать - утвердить Code Convention...
Потому что иначе ТАКОЙ раздрай в сорсах, что разобраться в чужом коде становится нереально...

palva © (13.08.08 13:44) [27]
Это можно сделать и без Net.
Маленькаая прога написанная самостоятельно решит дело, но основная проблема в том ЧТО писать в комментах и БУДУТ ли их писать вообще.
Пробовали вводить такое дело. Кончилось плачевно. Пишут всякую ерунду включая приколы :)

Удалено модератором

>Пишут всякую ерунду включая приколы :)

Пару раз высечь рублем - навсегда прекратят

Удалено модератором

Есть ли Общепринятые Стандарты по написанию программы? Найти похожие ветки