[Rust For Solana] Comments

다른 언어와 마찬가지로 // 와 /* */가 쓰이면서

문서같은 것을 작성할 때 ///가 쓰이며

 

문서 자체에 대한 주석이 필요할 때 //! 를 사용하면 됨

 

이런 식으로 작성한 이후에 아래 코드처럼 실행시켜보면

해당 코드가 target/doc 에 저장되며 cargo doc --open 명령어를 입력 시

 

 

이렇게 문서가 작성되며

초록색으로 된 add_one을 클릭시 아래 화면을 바뀐다

이외에 또 다른 스타일로 //! 가 있는데

이 명령어는 주석 뒤에 오는 항목을 문섷화 하는게 아닌

주석을 포함하는 항목을 문서화한다.

 

 

4번째 줄 위로 //! 를 포함한 문서의 설명을 넣어서

다시 cargo doc --open 을 실행시켜보면

ㅇㅋ

My Crate부분이 추가된 것을 알 수 있음

 

일단 당장 문서를 만들건 아니니까 여기까지 ...

아 그리고 이렇게 문제는 없지만 에디터에서 경고를 해주는 경우

앞에 _x -> underscore 를 붙여주면 잠시 에디터가 이를 무시할 수 있다!