Bu yazımda github’da daha okunabilir Readme’leri nasıl oluştururuz onu anlatacağım. İlk olarak bunun nerden çıktığını bilmek isteyenler olabilir. Bu konu üzerine türkçe olarak paylaşımda bulunmak istedim.
Kısaca nasıl kullanıldığından bahsedeyim. Bunun için özel bir editör kullanmayacağız. (notepad,vim,…). Sanki bir html sayfa oluştururmuş gibi yolumuza devam edeceğiz. Ben anlatırken, html’deki karşılıklarını yazarak daha kolay anlaşılacağını düşündüğüm için, bu yöntemi kullanacağım. Ayrıca Readme dosyası diye nitelendirdiğim dosya sadece Readme dosyalarında geçerli olduğunu göstermemektedir. Sadece yazıda koukluk olamaması açısından her yerde Readme dosyası diye nitelendirmekteyim. Bu yapıyı .md ya da gördüğüm kadarı ile .markdown dosyalarında kullanabilirsiniz.
<h1>tagının başlık olduğunu biliyoruz ve bu başlığı Github’da da oluşturmak için
Başlık Metni
============
Burada “=”lerin bir sayısı yoktur.İstediğiniz kadar koyabilirsiniz. Ben yazılan metnin boyuna eşit koymaya çalışıyorum. Aynı şekilde bu başlığı şöyledeoluşturabiliriz.
# Başlık Metni
Bu <h1> in karşılığı olacaktır. Bunun yanında <h2>, <h3>, …, <h6>’da sırasıyla aşağıdaki gibidir.
# Başlık Metni - Bu bir <h1>
## Başlık Metni - Bu bir <h2>
### Başlık Metni - Bu bir <h3>
###### Başlık Metni - Bu bir <h6>
Yazılan her yeni satır bir paragraf olacaktır zaten.
Bunun yanında yazımıda bir liste olamsı gerekiyor ise bunu şu şekilde oluşturabiliriz.
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.
* Lorem Ipsum is simply dummy text of the printing and typesetting industry.
* Lorem Ipsum is simply dummy text of the printing and typesetting industry.
* Lorem Ipsum is simply dummy text of the printing and typesetting industry.
* Lorem Ipsum is simply dummy text of the printing and typesetting industry.
* Lorem Ipsum is simply dummy text of the printing and typesetting industry.
Diyelim ki liste stilimizi sıralı bir liste olarak oluşturmak istiyoruz. Bu durumda da şöyle bir yöntem kullanabiliriz.
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.
1. Lorem Ipsum is simply dummy text of the printing and typesetting industry.
2. Lorem Ipsum is simply dummy text of the printing and typesetting industry.
3. Lorem Ipsum is simply dummy text of the printing and typesetting industry.
4. Lorem Ipsum is simply dummy text of the printing and typesetting industry.
Dosyamızda başka sayfalara link vermek içinse şöyle bir yöntem kullanıyoruz.
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown [printer][printer2Url] took a galley of type and scrambled it to make a type specimen book.
Burada yazdığımız “[printer][printer2Url]“ kısmını sayfa sonunda ya da herhangi bir yerinde aşağıdaki gibi tamamlıyoruz ve linkimiz kullanılabilir hale gelmiş oluyor.
[printer2Url]: www.hp.com.tr
Denememekle birlikte bir sitede gördüğüm kadarı ile linkleri aşağıdaki gibi de tanımlayabiliriz.
Bu bir [örnektir](http://ornek_site.com/ "Başlık") satır içi linke.
[Bu link](http://example.net/) Bir başlığa sahip değil.
Readme dosyanıza ya da herhangi bir bir kod parçası yazmak istediğinizde her satırın başını 4 boşluk karakteri ya da bir tab karakteri ile doldurmanız yeterlidir. Örneğin aşağıda:
____<script src="jquery.js"></script> <!-- Bu satır eklenmeli -->
Not: Ben burada boşluk karakteri yerine “_” (alttan tire) işareti koydum.
Yazınım devamının geleceğine inanıyorum. Kısaca github markup bu şekilde. Teşekkürler.
Bağlantılar :
https://github.com/github/markup
http://www.fileinfo.com/extension/md
http://daringfireball.net/projects/markdown/
http://en.wikipedia.org/wiki/Markdown
XML Documentation Sample – XML Dökümantasyon Örneği
04.16.2011, No Comments, Uncategorized, by Haydar KULEKCI.Bu yazımda XML Documentation C#’da nasıl oluşturulur ondan bahsedeceğim. Bu yazım sadece ingilizce bir kaynağın türkçeleştirilmiş halidir.
Elimden geldiğince Türkçe bir örnek yazmaya çalıştım. Program içerisinde geçen cümle ya da komutları haliyle türkçeleştirmedim. Daha kolay anlaşılacağını umuyorum.
örnek
Visual Studio ile XML Dökümantasyon örneği oluşturmak için
Komut Satırından ile XML Dökümantasyon örneği oluşturmak için
Yararlanılan Kaynkalar:
http://msdn.microsoft.com/en-us/library/aa288481%28v=vs.71%29.aspx
http://stackoverflow.com/questions/48381/generating-documentation-from-c-xml-comments
http://www.codeproject.com/KB/cpp/TestXMLdoc.aspx