Стилевой кодовый минимум — различия между версиями

Материал из YourcmcWiki
Перейти к: навигация, поиск
м
м
 
(не показано 5 промежуточных версий этого же участника)
Строка 23: Строка 23:
 
Во-первых, опять-таки их нужно '''хотя бы форматировать одинаково''' по всей программе. А во-вторых, фигурные скобочки должны быть '''на одном уровне''' с началом блока!
 
Во-первых, опять-таки их нужно '''хотя бы форматировать одинаково''' по всей программе. А во-вторых, фигурные скобочки должны быть '''на одном уровне''' с началом блока!
  
{| class="wikitable"
+
<html><table class="wikitable"><tr><th width="33%"></html>
|-
+
Очень желательно:
!width="33%" valign=top| Очень желательно:
+
<html></th><th width="33%"></html>
!width="33%" valign=top| Можно, но не нужно — визуально тело сливается с условием:
+
Можно, но не нужно — визуально тело сливается с условием:
!width="33%" valign=top| НИ В КОЕМ СЛУЧАЕ:
+
<html></th><th width="33%"></html>
|-
+
НИ В КОЕМ СЛУЧАЕ:
|
+
<html></th></tr><tr><td style="vertical-align: top"></html>
<pre>if (...)
+
<pre>
 +
if (...)
 
{
 
{
 
     код...
 
     код...
}</pre>
+
}
|
+
</pre>
<pre>if (...) {
+
<html></td><td style="vertical-align: top"></html>
 +
<pre>
 +
if (...) {
 
     код...
 
     код...
}</pre>
+
}
Хотя, например, [http://perldoc.perl.org/perlstyle.html perlstyle] предлагает именно этот способ форматирования блоков, лично я не использую его и в Perl-коде, ибо неудобно.
+
</pre>
|
+
Хотя, например, [http://perldoc.perl.org/perlstyle.html perlstyle] предлагает именно этот способ форматирования блоков, лично я не использую его и в Perl-коде тоже.
<pre>if (...)
+
<html></td><td style="vertical-align: top; background-position: 50px 50px; background-image: url(http://yourcmc.ru/wiki/images/9/9a/Nocross.svg)"></html>
 +
<pre style="background-color: transparent">
 +
if (...)
 
     {
 
     {
 
     код...
 
     код...
Строка 46: Строка 51:
 
</pre>
 
</pre>
 
или
 
или
<pre>if (...)
+
<pre style="background-color: transparent">
 +
if (...)
 
   {
 
   {
 
     код...
 
     код...
   }</pre>
+
   }
 
+
</pre>
|}
+
<html></td></tr></table></html>

Текущая версия на 01:05, 30 мая 2011

Чтобы был качественный код, лучше следовать какому-то Style Guide, например гугловскому: http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml

Но «чтобы не было говна», какому стилю следовать — не так важно, главное следовать хоть какому-то.

Как минимум:

Отступы

Я рекомендую использовать для отступов только пробелы и размер табуляции в 4 символа. НО не так важно, табы или пробелы и какой размер табуляции!

Важно, чтобы размер отступа был ОДИНАКОВЫЙ по всей программе и чтобы не было СМЕСИ табов с пробелами!

В Интернетах есть куча срачей на тему «табы vs пробелы», но когда в тред приходит человек, который говорит, что ему всё равно, хоть смесь — его точно бьют и те, и другие :)

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

Если в редакторе есть ещё и режим «эмуляции половины таба», обязательно отключите и его, ибо он генерирует смесь табов и пробелов! Пример такого редактора — встроенный в Midnight Commander.

Если же используем табы, то делаем все отступы исключительно табами!

Блоки и функции

Во-первых, опять-таки их нужно хотя бы форматировать одинаково по всей программе. А во-вторых, фигурные скобочки должны быть на одном уровне с началом блока!

Очень желательно: Можно, но не нужно — визуально тело сливается с условием: НИ В КОЕМ СЛУЧАЕ:

if (...)
{
    код...
}

if (...) {
    код...
}

Хотя, например, perlstyle предлагает именно этот способ форматирования блоков, лично я не использую его и в Perl-коде тоже.

if (...)
    {
    код...
    }

или

if (...)
  {
    код...
  }