Skip to content

Commit

Permalink
add th-comments.md translations
Browse files Browse the repository at this point in the history
  • Loading branch information
ghiippiez committed May 14, 2018
1 parent f51d529 commit 9117598
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 22 deletions.
14 changes: 7 additions & 7 deletions th/5/13-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -443,16 +443,16 @@ contract Math {

ซึ่งคุณไม่ต้องใช้ทั้งหมดนี้เสมอไปในทุกๆ function เพราะแท็กเหล่านี้เป็นเพียงตัวเลือกเท่านั้น แต่อย่างน้อยที่สุดก็ควรจะมีการแท็ก `@dev` เพื่อให้ developer ท่านอื่นได้เข้าใจ function ได้ดีขึ้น

# Put it to the test
# มาทดสอบกัน

If you haven't noticed by now, the CryptoZombies answer-checker ignores comments when it checks your answers. So we can't actually check your natspec code for this chapter ;)
หากไม่ได้สังเกตุ ส่วนของ CryptoZombies answer-checker จะไม่สนใน comment ต่าง ๆ เวลาเช็คคำตอบของเรา ดังนั้นเราจึงไม่สามารถเช็ค natspec โค้ดของทุกท่านได้ในบทนี้ ;)

However, by now you're a Solidity whiz — we're just going to assume you've got this!
แต่ถึงอย่างนั้นก็ตาม เราเชื่อว่าคุณเป็นถึงผู้เชี่ยวชาญในเรื่องของ Solidity ไปแล้วนี่นา — เราจะสมมติว่าคุณเข้าใจสิ่งที่เราพูดไปทั้งหมดเลยก็แล้วกัน!

Give it a try anyway, and try adding some natspec tags to `ZombieOwnership`:
ลองเพิ่ม natspec tags ไปยัง `ZombieOwnership` กันดู:

1. `@title` — E.g. A contract that manages transfering zombie ownership
1. `@title` — ตัวอย่างเช่น นี่คือcontract ที่ช่วยจัดการการส่งต่อ ownership ต่อซอมบี้

2. `@author` — Your name!
2. `@author` — ชื่อของเรานี่ล่ะ!

3. `@dev`E.g. Compliant with OpenZeppelin's implementation of the ERC721 spec draft
3. `@dev`ตัวอย่างเช่น ทำตามแบบในโค้ดของ OpenZeppelin ของ ERC721 spec draft
30 changes: 15 additions & 15 deletions th/5/comments.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Comments
title: การสร้าง Comments
actions: ['checkAnswer', 'hints']
requireLogin: true
material:
Expand Down Expand Up @@ -28,12 +28,12 @@ material:
contract ZombieFeeding is ZombieFactory {
// 1. Remove this:
// 1. ลบบรรทัดนี้ออก:
address ckAddress = 0x06012c8cf97BEaD5deAe237070F9587f8E7A266d;
// 2. Change this to just a declaration:
// 2. เปลี่ยนส่วนนี้ให้เป็นเพียงแค่การประกาศค่าเท่านั้น:
KittyInterface kittyContract = KittyInterface(ckAddress);
// 3. Add setKittyContractAddress method here
// 3. เพิ่ม method ที่ชื่อ setKittyContractAddress ตรงนี้เลยจ้า
function feedAndMultiply(uint _zombieId, uint _targetDna, string _species) public {
require(msg.sender == zombieToOwner[_zombieId]);
Expand Down Expand Up @@ -141,35 +141,35 @@ material:
}
---

Solidity, or BlockChain programming in general, has alot in common with the kind of programming done for the aerospace industry. That is, if you make a mistake, the plane falls from the sky, the rockets can't reach the moon, and [all your money gets stuck forever](https://medium.com/chain-cloud-company-blog/parity-multisig-hack-again-b46771eaa838).
โดยทั่วไปแล้วภาษาโปรแกรมมิ่งใน Solidity หรือ BlockChain เปรียบได้กับภาษาโปรแกรมมิ่งที่ใช้ในอุตสาหกรรมการบิน กล่าวคือหากมีข้อผิดพลาดขึ้นมาเพียงเล็กน้อยแล้วล่ะก็ อาจจะทำให้เครื่องบินทั้งลำตกลงมาก็เป็นได้ หรืออีกตัวอย่างก็คืออาจทำให้กระสวยอวกาศไปไม่ถึงดวงจันทร์ตามที่ตั้งใจไว้ และจะทำให้เรา [สูญเสียรายได้กันไปอย่างมหาศาลเลยทีเดียว](https://medium.com/chain-cloud-company-blog/parity-multisig-hack-again-b46771eaa838).

So it becomes really really important that you double, triple check everything and make every effort to clarify the meaning and the intention behind each line of code.
ความสำคัญของมันจึงสูงมากพอที่จำเป็นจะต้องมีการตรวจสอบจำนวนสอง หรือสามรอบด้วยความใส่ใจในทุก ๆ องค์ประกอบเพื่อบอกได้ถึงความหมายและจุดประสงค์เบื้องหลังโค้ดในแต่ละบรรทัด

This is why we are taking time to go over `comments` and their importance in Solidity programming.
เรื่องนี้จึงได้นำมาสู่เหตุผลที่ว่าทำไมเราจึงควรให้เวลาไปกับการคอมเม้น `comments` และความสำคัญของมันภายใน Solidity programming.

## Commenting with Style:
## การสร้างคอมเม้นด้วยรูปแบบต่าง ๆ (Commenting with Style):

```
// This is a single-line comment. It's kind of like a note to self (or to others)
// ส่วนนี้คือการคอมเม้นภายในหนึ่งบรรทัด ซึ่งมันก็คือการสร้างโน้ตให้กับตัวเราเองนี่ล่ะ (หรือให้คนอื่นอ่านก็ได้นะ)
```

Just add double `//` anywhere and you're commenting. It's so easy that you should do it all the time. But I hear you, sometimes a single line is not enough, you are born a writer:
เพียงแค่เพิ่มเครื่องหมาย `//` ณ ตรงที่ใดก็ได้ก็จะหมายถึงว่าขณะนั้นเรากำลังสร้างคอมเม้นแล้ว ซึ่งอะไรแบบนี้เป็นเรื่องที่ควรทำให้เป็นนิสัยอย่างมากเนื่องจากมันเป็นอะไรที่ง่ายสุด ๆ แต่อย่างไรก็ตาม เราทราบดีว่าบางทีการคอมเม้นภายในหนึ่งบรรทัดมันก็ไม่เพียงพอสำหรับนักเขียนมือฉมังอย่างเรา ๆ อะเนอะ:

```
contract CryptoZombies {
/*
This is a multi-lined comment. I'd like to thank all of you who have taken your time to try this programming course. I know it's free to all of you, and it will stay free forever, but we still put our heart and soul into making this as good as it can be.
ตัวอย่างนี้คือการสร้างคอมเม้นแบบหลายบรรทัด ขอขอบคุณทุกๆ คนมากที่เสียสละเวลามาศึกษาคอร์สโปรแกรมมิ่งนี้ แม้ว่าเราจะเปิดบทเรียนนี้ให้เข้ามาศึกษากันแบบฟรี ๆ และแน่นอนว่ามันจะเป็นแบบนี้เสมอ เราก็ยังยืนยันว่าจะใส่หัวใจและจิตวิญญาณในการทำมันให้ดีที่สุดเท่าที่จะทำได้เลยนะ
Know that this is still the beginning of Blockchain development. We've come very far but there are so many ways to make this community better. If we made a mistake somewhere, you can make a pull request here: https://github.com/loomnetwork/cryptozombie-lessons
ขอให้รู้ไว้ว่านี่เป็นเพียงแค่จุดเริ่มต้นในการพัฒนาบล็อกเชนเท่านั้น แม้ว่าเราอาจจะมากันไกลมากกว่าในตอนแรกเป็นที่เรียบร้อย แต่ก็ยังมีอีกหลายอย่างที่ต้องมาเรียนรู้กันเพื่อพัฒนาให้คอมมูนิตี้นี้ดีขึ้นกว่าเดิมให้ได้ หากว่าทางทีมของเราได้ทำผิดพลาดไว้ตรงไหนก็สามารถเข้ามาบอกกันได้โดยสร้าง pull request เอาไว้ที่นี่เล้ย: https://github.com/loomnetwork/cryptozombie-lessons
Or if you have some ideas, comments, or just want to say hi - drop by our Telegram.
ไอเดียหรือคอมเม้นใหม่ ๆ ที่อยากจะมาแลกเปลี่ยนกัน หรือแม้แต่การแวะมาทักทายเฉย ๆ ก็ได้ - ให้เข้ามาเยี่ยมเยียนกันที่ Telegram ของเรานะจ๊ะ
*/
}
```

But sometimes the written language is not precise enough, or you want to make it really easy for others to read, then it's time to add real documentation.
แต่บางครั้งภาษาที่เราใช้เขียนก็อาจจะไม่ได้เป๊ะเท่าที่ควรนัก หรือแม้แต่กรณีที่เราต้องการให้มันอ่านง่าย ทำให้จะถึงเวลาของการเพิ่ม document จริง ๆ เข้าไปแล้ว

In this community, the general trend is to use `Doxygen` style tags. These tags are just a special way of writting comments that are clearer and machine readable. It makes it easier to generate documentation for others.
ในคอมมูนิตี้ของเรานี้ มีเทรนด์ที่กำลังนิยมในการใช้แท็ก (tags) `Doxygen` style อยู่ โดย tags เหล่านี้ก็เป็นเพียงแค่วิธีพิเศษที่เพิ่มเข้ามาในการเขียนคอมเม้นที่จะทำมันมีความชัดเจนยิ่งขึ้นและ machine ก็สามารถอ่านได้ง่ายด้วย ซึ่งผลที่ตามมาก็คือความง่าต่อการสร้างเอกสารหรือ docimentation สำหรับผู้อื่น

```
/** @title A basic math operation. */
Expand Down

0 comments on commit 9117598

Please sign in to comment.