diff --git a/th/5/comments.md b/th/5/comments.md index 4472b1e88..81d75ea2c 100644 --- a/th/5/comments.md +++ b/th/5/comments.md @@ -143,31 +143,31 @@ material: โดยทั่วไปแล้วภาษาโปรแกรมมิ่งใน Solidity หรือ BlockChain เปรียบได้กับภาษาโปรแกรมมิ่งที่ใช้ในอุตสาหกรรมการบิน กล่าวคือหากมีข้อผิดพลาดขึ้นมาเพียงเล็กน้อยแล้วล่ะก็ อาจจะทำให้เครื่องบินทั้งลำตกลงมาก็เป็นได้ หรืออีกตัวอย่างก็คืออาจทำให้กระสวยอวกาศไปไม่ถึงดวงจันทร์ตามที่ตั้งใจไว้ และจะทำให้เรา [สูญเสียรายได้กันไปอย่างมหาศาลเลยทีเดียว](https://medium.com/chain-cloud-company-blog/parity-multisig-hack-again-b46771eaa838). -ความสำคัญของมันจึงสูงมากพอที่จำเป็นจะต้องมีการตรวจสอบจำนวนสอง หรือสามรอบด้วยความใส่ใจในทุก ๆ องค์ประกอบเพื่อบอกได้ถึงความหมายและจุดประสงค์เบื้องหลังโค้ดในแต่ละบรรทัด +ความสำคัญของมันจึงสูงมากพอที่จำเป็นจะต้องมีการตรวจสอบจำนวนสอง หรือสามรอบด้วยความใส่ใจในทุกๆ องค์ประกอบเพื่อบอกได้ถึงความหมายและจุดประสงค์เบื้องหลังโค้ดในแต่ละบรรทัด เรื่องนี้จึงได้นำมาสู่เหตุผลที่ว่าทำไมเราจึงควรให้เวลาไปกับการคอมเม้น `comments` และความสำคัญของมันภายใน Solidity programming. -## การสร้างคอมเม้นด้วยรูปแบบต่าง ๆ (Commenting with Style): +## การสร้างคอมเม้นด้วยรูปแบบต่างๆ (Commenting with Style): ``` // ส่วนนี้คือการคอมเม้นภายในหนึ่งบรรทัด ซึ่งมันก็คือการสร้างโน้ตให้กับตัวเราเองนี่ล่ะ (หรือให้คนอื่นอ่านก็ได้นะ) ``` -เพียงแค่เพิ่มเครื่องหมาย `//` ณ ตรงที่ใดก็ได้ก็จะหมายถึงว่าขณะนั้นเรากำลังสร้างคอมเม้นแล้ว ซึ่งอะไรแบบนี้เป็นเรื่องที่ควรทำให้เป็นนิสัยอย่างมากเนื่องจากมันเป็นอะไรที่ง่ายสุด ๆ แต่อย่างไรก็ตาม เราทราบดีว่าบางทีการคอมเม้นภายในหนึ่งบรรทัดมันก็ไม่เพียงพอสำหรับนักเขียนมือฉมังอย่างเรา ๆ อะเนอะ: +เพียงแค่เพิ่มเครื่องหมาย `//` ณ ตรงที่ใดก็ได้ก็จะหมายถึงว่าขณะนั้นเรากำลังสร้างคอมเม้นแล้ว ซึ่งอะไรแบบนี้เป็นเรื่องที่ควรทำให้เป็นนิสัยอย่างมากเนื่องจากมันเป็นอะไรที่ง่ายสุดๆ แต่อย่างไรก็ตาม เราทราบดีว่าบางทีการคอมเม้นภายในหนึ่งบรรทัดมันก็ไม่เพียงพอสำหรับนักเขียนมือฉมังอย่างเราๆ อะเนอะ: ``` contract CryptoZombies { /* - ตัวอย่างนี้คือการสร้างคอมเม้นแบบหลายบรรทัด ขอขอบคุณทุกๆ คนมากที่เสียสละเวลามาศึกษาคอร์สโปรแกรมมิ่งนี้ แม้ว่าเราจะเปิดบทเรียนนี้ให้เข้ามาศึกษากันแบบฟรี ๆ และแน่นอนว่ามันจะเป็นแบบนี้เสมอ เราก็ยังยืนยันว่าจะใส่หัวใจและจิตวิญญาณในการทำมันให้ดีที่สุดเท่าที่จะทำได้เลยนะ + ตัวอย่างนี้คือการสร้างคอมเม้นแบบหลายบรรทัด ขอขอบคุณทุกๆ คนมากที่เสียสละเวลามาศึกษาคอร์สโปรแกรมมิ่งนี้ แม้ว่าเราจะเปิดบทเรียนนี้ให้เข้ามาศึกษากันแบบฟรีๆ และแน่นอนว่ามันจะเป็นแบบนี้เสมอ เราก็ยังยืนยันว่าจะใส่หัวใจและจิตวิญญาณในการทำมันให้ดีที่สุดเท่าที่จะทำได้เลยนะ ขอให้รู้ไว้ว่านี่เป็นเพียงแค่จุดเริ่มต้นในการพัฒนาบล็อกเชนเท่านั้น แม้ว่าเราอาจจะมากันไกลมากกว่าในตอนแรกเป็นที่เรียบร้อย แต่ก็ยังมีอีกหลายอย่างที่ต้องมาเรียนรู้กันเพื่อพัฒนาให้คอมมูนิตี้นี้ดีขึ้นกว่าเดิมให้ได้ หากว่าทางทีมของเราได้ทำผิดพลาดไว้ตรงไหนก็สามารถเข้ามาบอกกันได้โดยสร้าง pull request เอาไว้ที่นี่เล้ย: https://github.com/loomnetwork/cryptozombie-lessons - ไอเดียหรือคอมเม้นใหม่ ๆ ที่อยากจะมาแลกเปลี่ยนกัน หรือแม้แต่การแวะมาทักทายเฉย ๆ ก็ได้ - ให้เข้ามาเยี่ยมเยียนกันที่ Telegram ของเรานะจ๊ะ + ไอเดียหรือคอมเม้นใหม่ๆ ที่อยากจะมาแลกเปลี่ยนกัน หรือแม้แต่การแวะมาทักทายเฉยๆ ก็ได้ - ให้เข้ามาเยี่ยมเยียนกันที่ Telegram ของเรานะจ๊ะ */ } ``` -แต่บางครั้งภาษาที่เราใช้เขียนก็อาจจะไม่ได้เป๊ะเท่าที่ควรนัก หรือแม้แต่กรณีที่เราต้องการให้มันอ่านง่าย ทำให้จะถึงเวลาของการเพิ่ม document จริง ๆ เข้าไปแล้ว +แต่บางครั้งภาษาที่เราใช้เขียนก็อาจจะไม่ได้เป๊ะเท่าที่ควรนัก หรือแม้แต่กรณีที่เราต้องการให้มันอ่านง่าย ทำให้จะถึงเวลาของการเพิ่ม document จริงๆ เข้าไปแล้ว ในคอมมูนิตี้ของเรานี้ มีเทรนด์ที่กำลังนิยมในการใช้แท็ก (tags) `Doxygen` style อยู่ โดย tags เหล่านี้ก็เป็นเพียงแค่วิธีพิเศษที่เพิ่มเข้ามาในการเขียนคอมเม้นที่จะทำมันมีความชัดเจนยิ่งขึ้นและ machine ก็สามารถอ่านได้ง่ายด้วย ซึ่งผลที่ตามมาก็คือความง่าต่อการสร้างเอกสารหรือ docimentation สำหรับผู้อื่น @@ -183,4 +183,4 @@ contract multiply { z = x * y; } } -``` \ No newline at end of file +```