Форум Flasher.ru

Форум Flasher.ru (http://www.flasher.ru/forum/index.php)
-   Флейм (http://www.flasher.ru/forum/forumdisplay.php?f=53)
-   -   Конвенции кодирования (http://www.flasher.ru/forum/showthread.php?t=142511)

Котяра 23.07.2010 00:27

Конвенции кодирования
 
Предлагаю в разделе AS3 создать и прикрепить важную тему со ссылкой на конвенции кодирования:
http://opensource.adobe.com/wiki/dis...ng+Conventions
+ статьи Бармалея:
http://garbage-collector.ru/2008/06/...n_russian.html
+ ссылки на топики по обсуждению конвенций.(нужно поискать)

Теперь полуоффтоп вопрос:
как называть свойство,
itemId или itemID ? Мучает меня постоянно)

второй вопрос:
пакеты рекомендуется называть в camelStyle
меня это смущает, так как пакеты это папки и они должны быть nonCS. (артефакт конечно - но это реалии)
Я называю многословные пакеты как crazy_components. Из ит труъ?

udaaff 23.07.2010 01:10

Цитата:

Сообщение от Котяра (Сообщение 924239)
Теперь полуоффтоп вопрос:
как называть свойство,
itemId или itemID ? Мучает меня постоянно)

Я так понимаю, что Id — сокращение слова identification, а не аббревиатура, поэтому itemId.
Цитата:

Сообщение от Котяра (Сообщение 924239)
второй вопрос:
пакеты рекомендуется называть в camelStyle
меня это смущает, так как пакеты это папки и они должны быть nonCS. (артефакт конечно - но это реалии)
Я называю многословные пакеты как crazy_components. Из ит труъ?

Цитата:

Сообщение от iNils
99% это одно слово
в 1% это выглядит ка кодно слово. то есть videochat, а не videoСhat


Котяра 23.07.2010 01:19

2udaaff. За itemId - сенки. Почему-то показалось ID аббревиатурой - проанализировать даже в голову не пришло :)
А откуда нильсовская цитата?
И что модераторы думают про основную тему топика?

expl 23.07.2010 01:21

Цитата:

второй вопрос:
пакеты рекомендуется называть в camelStyle
меня это смущает
как в соглашении конторы написано, так и называйте

В одном проекте народ называл в кемел-стайле с большой буквы например, SomeForm
По другому соглашению вообще запрещено было двусложное название пакета,
т.е. надо было делать 2 пакета: some.form

Через "_" не сталкивался
Ну раз Адоби рекомендует через кемелстайл с маленькой буквы - ради чего фантазировать - приемлемо - используй!

Котяра 23.07.2010 01:24

в том то и дело что неприемлимо. объединение в someforms - тоже плохо читается, но лучшее из худших.

expl 23.07.2010 01:27

"плохо читается" - ИМХО агргумент слишком субхективный.
К любому кодостайлу привыкаешь через неделю и уже кажется что раньше как-то не правильно писал.

А вот если изобретешь свой - потом сложно будет подсадить на него коллег или переключиться на другой.

Единсвенное, очень надеюсь, что НЕ придется столкнуться со стилем, где перед каждым приватным методом надо писать:
Код AS3:

/**
 * @private
 */

:)

udaaff 23.07.2010 01:41

Цитата:

Сообщение от expl (Сообщение 924246)
Единсвенное, очень надеюсь, что НЕ придется столкнуться со стилем, где перед каждым приватным методом надо писать:
Код AS3:

/**
 * @private
 */

:)

Думаю, что это не стиль, а незнание того, что в asdoc приватные методы и так не попадают. Такой комент пишется не перед приватными методами, если программист не хочет, чтобы метод попал в доку. А если у кого-то в стиле оформления кода такая ахинея есть, то, и в правду, лучше не сталкиваться...

Цитата:

А откуда нильсовская цитата?
И что модераторы думают про основную тему топика?
Цитата из аськи.
Ради нескольких ссылок создавать тему, как-то некашерно, по-моему. Хотя ссылки очень полезные, и хотелось бы, вообще, обязать пользователей оформлять свой код, который они выкладывают на форуме, в приемлемый вид. Но это из области фантастики.

Котяра 23.07.2010 01:53

Цитата:

в asdoc приватные методы и так не попадают.
а как заставить асдок документировать приватные методы? Например это надо для документации внутри компании.
Цитата:

Ради нескольких ссылок создавать тему, как-то некашерно
хорошо - распишу ссылки в более расширенном варианте,с цитатами и копипастой) просто я, например, много раз для ответов искал опять ссылку на конвенцию чтоб её вставить.. а тут раз - "читай прикриплённую тему"
Цитата:

обязать пользователей оформлять свой код, который они выкладывают на форуме, в приемлемый вид. Но это из области фантастики.
просто добавить предупреждение и бан, если не используют - грубо, но такова селяви))

BlooDHounD 23.07.2010 01:53

однажды мы решили, что решили Id выглядит убого. и решили, что ID выглядит круче. на том и порешили.

Котяра 23.07.2010 02:04

Цитата:

Сообщение от BlooDHounD (Сообщение 924257)
однажды мы решили, что решили Id выглядит убого. и решили, что ID выглядит круче. на том и порешили.

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


Часовой пояс GMT +4, время: 10:28.

Copyright © 1999-2008 Flasher.ru. All rights reserved.
Работает на vBulletin®. Copyright ©2000 - 2024, Jelsoft Enterprises Ltd. Перевод: zCarot
Администрация сайта не несёт ответственности за любую предоставленную посетителями информацию. Подробнее см. Правила.