> For the complete documentation index, see [llms.txt](https://piharpi.gitbook.io/rubyist/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://piharpi.gitbook.io/rubyist/konvensi-penulisan.md).

# Konvensi Penulisan

Konvensi adalah tentang aturan penulisan pada buku ini supaya pembaca memahami maksud dari contoh-contoh yang diberikan oleh penulis, sehingga pembaca dapat membaca buku ini dengan pemahaman yang baik

Pada buku ini akan sering bertemu dengan *code block* atau sebuah blok kode didalam buku ini mempunyai 2 jenis code block.

* Sebagai perintah Terminal
* Sebagai potongan kode Ruby

### Perintah Terminal

{% code title="Terminal" %}

```bash
$ cd belajar # tanda $(dollar sign) tidak perlu dituliskan
$ touch hello.rb
$ exit
```

{% endcode %}

Pada *code block* berjudul `Terminal` maksud penulis bahwa perintah didalam *code block* diatas harus dieksekusi didalam terminal.

Tanda `$` (dollar sign) tidak perlu dituliskan, itu hanya sebagai tanda bahwa  berada pada lingkungan terminal,  *line number* disisi kiri pada code block berguna untuk penunjuk baris perintah.

Contoh penunjuk baris :\
Baris `2` adalah perintah untuk membuat sebuah file `hello.rb` .

### Kode Ruby

{% tabs %}
{% tab title="user.rb" %}
{% code title="user.rb" %}

```ruby
# User class didalam file user.rb
class User
  attr_accessor :name, :username, :email
  attr_writer :password

  def initialize(name, username, email, password)
    @name = name
    @email = email
    @username = username
    @password = password
  end
  
  def info
    "Halo nama saya #{name}, hubungi saya di #{email}"
  end
end
```

{% endcode %}
{% endtab %}

{% tab title="main.rb" %}
{% code title="main.rb" %}

```ruby
require_relative 'user.rb'

usr = User.new('Harpi', 'piharpi', 'justharpi@gmail', 'secret')

puts user.info
```

{% endcode %}
{% endtab %}

{% tab title="Result" %}
{% code title="Terminal" %}

```bash
$ ruby main.rb
Halo nama saya Harpi, hubungi saya di justharpi@gmail
=> nil
```

{% endcode %}
{% endtab %}
{% endtabs %}

Code Block diatas terdapat `main.rb`  dan `user.rb` kedua file tersebut berkaitan, terkadang saya hanya menyematkan satu file saja, pada kasus ini saya menyematkan dua file untuk memberikan contoh.

Pada code block tersebut berisi kode ruby dari file `user.rb` karena sedang aktif coba klik bagian `main.rb` maka isi code block juga akan berubah, dan sisi kiri code block terdapat line number yang mempermudah untuk menunjuk kode ruby yang ingin penulis jelaskan.

Yang terakhir terdapat tab **Result** menampilkan informasi yang dihasilkan dari eksekusi kode program ruby.

Contoh penunjuk baris :\
Baris `13` pada file `user.rb` adalah sebuah method `info` yang berfungsi untuk mengembalikan informasi dari `Class User`.    

{% hint style="info" %}
Meskipun code block menyediakan fitur copy secara otomatis, saya sarankan tidak menggunakan itu, saya harap kamu mengerti alasanya, disini kamu tujuanya belajar pemprograman ruby **bukan** salin dan tempel.
{% endhint %}

\