Menambahkan Dokumentasi di Modul Elixir

Dokumentasi adalah sarana untuk membuat programmer lain lebih paham terhadap modul atau function yang dibuat oleh pembuat kode sebelumnya. Menambahkan dokumentasi di modul Elixir cukup mudah, Anda dapat menambahkan dokumentasi untuk modul dengan menggunakan keyword @moduledoc, @vsn untuk versi modul, dan @doc untuk function. Sekarang mari kita coba buat kode berikut di file documenting.ex:



defmodule PersegiPanjang do
    @moduledoc """
    Persegi Panjang adalah sebuah bidang dua dimensi yang memiliki dua panjang dan dua lebar.
    """

    @vsn 1.0

    @doc """
    function ini digunakan untuk menghitung luas persegi panjang
    """
    def luas(p, l) do                                                                                                      
        p * l
    end

    @doc """
    function ini digunakan untuk menghitung keliling persegi panjang
    """
    def keliling(p, l) do
        (2 * p) + (2 * l)
    end
end

IO.puts(PersegiPanjang.luas(10, 5))
IO.puts(PersegiPanjang.keliling(10, 5))

Mari kita coba periksa dokumentasinya melalui iex di konsol:



$ iex
Erlang/OTP 18 [erts-7.3]  [64-bit] [smp:4:4] [async-threads:10] [kernel-poll:false]

Interactive Elixir (1.2.3) - press Ctrl+C to exit (type h() ENTER for help)
iex(1)> c("documenting.ex")
documenting.ex:1: warning: redefining module PersegiPanjang
50
30
[PersegiPanjang]
iex(2)> h PersegiPanjang

                                 PersegiPanjang                                 

Persegi Panjang adalah sebuah bidang dua dimensi yang memiliki dua panjang dan
dua lebar.

iex(3)> h PersegiPanjang.luas

                                 def luas(p, l)                                 

function ini digunakan untuk menghitung luas persegi panjang

iex(4)> h PersegiPanjang.keliling

                               def keliling(p, l)                               

function ini digunakan untuk menghitung keliling persegi panjang

iex(5)>

One Comments

  • Bram July 10, 2017 Reply

    Wah keren kang, mudah sekali ternyata membuat dokumentasi nya ya

Leave a Reply