Arduino style guideThis is a guide

Arduino style guide
This is a guide for writing clear Arduino examples that can be read by beginners and advanced users alike. You don't have to code this way, but it helps if you want your code to be clear to all levels of users. This is not a set of hard and fast rules, it's a set of guidelines. Some of these guidelines might even conflict with each other. Use your judgment on when they're best followed, and if you're not sure, ask someone who'll be learning from what you write what makes the most sense. You might also be interested in the API Style Guide for Arduino.
Writing a tutorial
(most of this is borrowed from various editors over the years)
Write in the active voice.
Write clearly and conversationally, as if the person following your instructions were there in the room with you.
When giving instruction, write in the second person, so the reader understands that she's the one who'll be doing it.
Use short, simple, declarative sentences and commands rather than compound sentences. It's easier for the reader to digest one instruction at a time.
Give directions in no uncertain terms like so:
"Next, you'll read the sensor..."
"Make a variable called thisPin..."
Avoid phrases that add no information. Don't tell the reader that "You want to set the pins", just tell her "Set the pins."
Use pictures and schematics rather than just schematics alone. Many electronics hobbyists don't read schematics.
Check your assumptions. Does the reader understand all the concepts you've used in your tutorial? If not, explain them or link to another tutorial that does.
Explain things conceptually, so the reader has a big picture of what he's going to do. Then lay out instructions on how to use it step-by-step.
Whenever you use a technical term for the first time, define it. Have someone else check that you defined all new terms. There are probably one or two that you missed.
Be consistent with the terms you use. If you refer to a component or concept by a new name, make the relationship to the other name explicit. Don't use two terms interchangeably unless you tell the reader that they are interchangeable.
Don't use acronyms or abbreviations without spelling them out first.
Make your example do one thing well. Don't combine concepts or functions unless it's a tutorial about combining concepts.
Writing Example Code
Efficiency is not paramount; readability is.
The most important users of Arduino are beginners and people who don't care about code, but about getting projects done.
Think generously about people who know less than you about code. Don't think they should understand some technical concept. They don't, and they're not stupid for not understanding. Your code should explain itself, or use comments to do the same. If it needs a complex concept like registers or interrupts or pointers, either explain it or skip it.
When forced to choose between technically simple and technically efficient, choose the former.
Introduce concepts only when they are useful and try to minimize the number of new concepts you introduce in each example. For example, at the very beginning, you can explain simple functions with no variable types other than int, nor for consts to define pin numbers. On the other hand, in an intermediate example, you might want to introduce peripheral concepts as they become useful. Concepts like using const ints to define pin numbers, choosing bytes over ints when you don't need more than 0 - 255, etc. are useful, but not central to getting started. So use them sparingly, and explain them when they're new to your lesson plan.
Put your setup() and your loop() at the beginning of the program. They help beginners to get an overview of the program, since all other functions are called from those two.
Commenting Your Code
Comment every variable or constant declaration with a description of what the variable does.
Comment every code block. Do it before the block if possible, so the reader knows what's coming
Comment every for loop
Use ve

Hasil (Bahasa Indonesia) 1:

Arduino Pedoman gaya WikisourceIni adalah panduan untuk menulis jelas contoh Arduino yang dapat dibaca oleh pemula dan lanjutan pengguna yang sama. Anda tidak perlu kode dengan cara ini, tetapi membantu jika Anda ingin kode Anda harus jelas untuk semua tingkatan dari pengguna. Ini bukanlah seperangkat aturan keras dan cepat, itu adalah seperangkat pedoman. Beberapa pedoman ini bahkan mungkin bertentangan dengan satu sama lain. Gunakan penilaian Anda pada ketika mereka terbaik sedang diikuti, dan jika Anda tidak yakin, meminta seseorang yang akan belajar dari apa yang Anda menulis apa yang membuat paling masuk akal. Anda mungkin juga akan tertarik dengan API gaya panduan untuk Arduino.Menulis tutorial (sebagian besar meminjam dari berbagai editor selama bertahun-tahun)Menulis secara aktif.Menulis dengan jelas dan santai, seolah-olah orang mengikuti petunjuk Anda ada di dalam ruangan dengan Anda.Ketika memberikan instruksi, menulis dalam orang kedua, sehingga pembaca memahami bahwa dia adalah orang yang akan melakukan itu.Menggunakan kalimat-kalimat pendek, sederhana, deklaratif dan perintah daripada senyawa kalimat. Lebih mudah bagi pembaca untuk mencerna satu instruksi pada suatu waktu.Memberikan petunjuk tegas seperti begitu:"Selanjutnya, Anda akan membaca sensor...""Membuat variabel disebut thisPin..."Hindari frase yang menambahkan informasi tidak. Jangan bilang pembaca bahwa "Anda ingin mengatur pin", hanya menceritakan "Set pin."Gunakan gambar dan skema daripada hanya skema sendirian. Banyak penggemar elektronik tidak membaca skema.Periksa asumsi Anda. Apakah pembaca memahami semua konsep-konsep yang telah digunakan dalam tutorial? Jika tidak, menjelaskan mereka atau link untuk tutorial lain itu.Menjelaskan hal-hal secara konseptual, sehingga pembaca memiliki gambar besar dari apa yang akan ia lakukan. Kemudian berbaring petunjuk tentang cara menggunakannya langkah demi langkah.Setiap kali Anda menggunakan istilah teknis untuk pertama kalinya, menentukan hal itu. Memiliki seseorang memeriksa bahwa Anda didefinisikan istilah semua baru. Mungkin ada satu atau dua yang Anda tidak terjawab.Konsisten dengan istilah yang Anda gunakan. Jika Anda merujuk ke komponen atau konsep dengan nama baru, membuat hubungan dengan nama lain eksplisit. Jangan menggunakan kedua istilah secara bergantian kecuali Anda memberitahu pembaca bahwa mereka tidak dapat dipertukarkan.Jangan menggunakan singkatan atau singkatan tanpa mengeja pertama.Membuat contoh melakukan satu hal Anda juga. Jangan menggabungkan konsep-konsep atau fungsi kecuali tutorial tentang menggabungkan konsep.Menulis contoh kodeEfisiensi tidak penting; adalah mudah dibaca.Pengguna paling penting Arduino adalah pemula dan orang-orang yang tidak peduli tentang kode, tapi tentang mendapatkan proyek-proyek yang dilakukan.Pikirkan bermurah hati orang-orang yang tahu kurang dari Anda tentang kode. Tidak berpikir mereka harus memahami beberapa konsep teknis. Mereka tidak, dan mereka tidak bodoh untuk tidak memahami. Kode Anda harus menjelaskan itu sendiri, atau gunakan komentar untuk melakukan hal yang sama. Jika perlu konsep kompleks seperti register atau menyela atau petunjuk, baik menjelaskan atau lewatkan saja.Ketika dipaksa untuk memilih antara teknis sederhana dan secara teknis efisien, memilih mantan.Memperkenalkan konsep hanya ketika mereka sangat berguna dan mencoba untuk meminimalkan jumlah konsep-konsep baru yang Anda memperkenalkan dalam setiap contoh. Sebagai contoh, di awal, Anda dapat menjelaskan fungsi sederhana dengan ada jenis variabel selain int, atau untuk consts untuk menentukan nomor pin. Di sisi lain, dalam contoh menengah, Anda mungkin ingin memperkenalkan konsep perifer mereka menjadi berguna. Konsep seperti menggunakan const ints untuk menentukan nomor pin, memilih byte atas ints bila Anda tidak membutuhkan lebih dari 0 - 255, dll berguna, tapi tidak pusat untuk memulai. Jadi gunakan dengan hemat, dan menjelaskan mereka ketika mereka masih baru rencana pelajaran Anda.Menempatkan setup() Anda dan loop() Anda pada awal program. Mereka membantu pemula untuk mendapatkan gambaran tentang program, karena semua fungsi lain disebut dari mereka berdua.Komentar kode AndaKomentar setiap Deklarasi variabel atau konstan dengan keterangan Apakah variabel.Komentar setiap blok kode. Melakukannya sebelum blok jika mungkin, sehingga pembaca tahu apa yang akan terjadiKomentar setiap untuk loopMenggunakan ve

Hasil (Bahasa Indonesia) 2:

Panduan gaya Arduino
ini adalah panduan untuk menulis contoh yang jelas Arduino yang dapat dibaca oleh pemula dan pengguna tingkat lanjut sama. Anda tidak perlu kode cara ini, tetapi membantu jika Anda ingin kode Anda harus jelas untuk semua tingkatan pengguna. Ini bukan seperangkat aturan keras dan cepat, itu seperangkat pedoman. Beberapa pedoman ini bahkan mungkin bertentangan satu sama lain. Gunakan penilaian Anda pada saat mereka terbaik diikuti, dan jika Anda tidak yakin, meminta seseorang yang akan belajar dari apa yang Anda menulis apa yang paling masuk akal. Anda mungkin juga tertarik dengan Panduan API Style untuk Arduino.
Menulis tutorial
(sebagian besar ini dipinjam dari berbagai editor selama bertahun-tahun)
Menulis di suara aktif.
Menulis dengan jelas dan santai, seolah-olah orang yang mengikuti petunjuk Anda berada di sana di ruangan dengan Anda.
Ketika memberikan instruksi, menulis dalam orang kedua, sehingga pembaca mengerti bahwa dia adalah orang yang akan melakukannya.
Gunakan singkat, sederhana, kalimat dan perintah deklaratif bukan kalimat majemuk. Lebih mudah bagi pembaca untuk mencerna satu instruksi pada satu waktu.
Berikan arah tegas seperti:
"Berikutnya, Anda akan membaca sensor ..."
"Membuat sebuah variabel yang disebut thisPin ..."
Hindari frase yang tidak menambahkan informasi. Jangan memberitahu pembaca bahwa "Anda ingin mengatur pin", katakan saja padanya "Set pin."
Menggunakan gambar dan skema bukan hanya Schematics saja. Penggemar elektronik banyak tidak membaca skema.
Periksa asumsi Anda. Apakah pembaca memahami semua konsep yang telah digunakan dalam tutorial Anda? Jika tidak, menjelaskan mereka atau link ke tutorial lain yang tidak.
Menjelaskan hal-hal konseptual, sehingga pembaca memiliki gambaran besar dari apa yang dia akan lakukan. Kemudian lay out petunjuk tentang cara menggunakan langkah-demi-langkah.
Setiap kali Anda menggunakan istilah teknis untuk pertama kalinya, mendefinisikannya. Memiliki orang lain memeriksa bahwa Anda mendefinisikan semua hal baru. Mungkin ada satu atau dua yang Anda tidak terjawab.
Konsisten dengan istilah yang Anda gunakan. Jika Anda mengacu pada komponen atau konsep dengan nama baru, membuat hubungan dengan nama lain yang eksplisit. Jangan menggunakan dua istilah bergantian kecuali Anda memberitahu pembaca bahwa mereka saling dipertukarkan.
Jangan menggunakan akronim atau singkatan tanpa mengeja mereka keluar pertama.
Membuat contoh Anda melakukan satu hal dengan baik. Jangan menggabungkan konsep atau fungsi kecuali itu adalah tutorial tentang menggabungkan konsep.
Menulis Contoh Kode
Efisiensi tidak penting; dibaca adalah.
Pengguna yang paling penting dari Arduino adalah pemula dan orang-orang yang tidak peduli tentang kode, tetapi tentang mendapatkan proyek dilakukan.
Pikirkan murah hati tentang orang-orang yang tahu kurang dari Anda tentang kode. Jangan berpikir mereka harus memahami beberapa konsep teknis. Mereka tidak, dan mereka tidak bodoh karena tidak mengerti. Kode Anda harus menjelaskan itu sendiri, atau menggunakan komentar untuk melakukan hal yang sama. Jika perlu konsep yang rumit seperti register atau menyela atau pointer, baik menjelaskannya atau lewatkan saja.
Ketika dipaksa untuk memilih antara teknis sederhana dan teknis efisien, memilih mantan.
Memperkenalkan konsep hanya ketika mereka berguna dan mencoba untuk meminimalkan jumlah konsep baru Anda memperkenalkan di setiap contoh. Misalnya, di awal, Anda dapat menjelaskan fungsi sederhana tanpa jenis variabel selain int, atau untuk consts untuk menentukan nomor pin. Di sisi lain, dalam contoh menengah, Anda mungkin ingin memperkenalkan konsep perifer karena mereka menjadi berguna. Konsep seperti menggunakan int const untuk menentukan nomor pin, memilih byte lebih int ketika Anda tidak perlu lebih dari 0-255, dll yang berguna, tapi tidak tengah untuk memulai. Jadi gunakan dengan hemat, dan menjelaskan mereka ketika mereka baru rencana pelajaran Anda.
Masukan setup Anda () dan loop () pada awal program. Mereka membantu pemula untuk mendapatkan gambaran dari program, karena semua fungsi lain yang dipanggil dari kedua.
Mengomentari Kode Anda
Komentar setiap deklarasi variabel atau konstanta dengan deskripsi tentang apa variabel tidak.
Komentar setiap blok kode. Melakukannya sebelum blok jika mungkin, sehingga pembaca tahu apa yang datang
Comment setiap untuk loop
Gunakan pernah