Bir Microsoft Word belgesine kaynak kodu örnekleri eklemenin en iyi yolu nedir?

Kaynak kod örneklerini içerecek bazı belgeler yazmam gerekiyor. Örneklerden bazıları IDE'den yazılacak ve diğerleri yerinde yazılacaktır. Örneklerim öncelikle Java'da.

LaTeX'e alışkın biri olarak bunu Word'de yapmak son derece acı vericidir. Ancak bunun için Word'e bağlıyım. Gördüğüm tek seçenek:

1. Belgeye yazın veya kopyalayın, ardından sabit bir yazı tipi kullanın, biçimlendirmeyi düzenleyin ve Word'ün sizin için büyük harf kullanmamasını umun. Söylemeye gerek yok, bu bok gibi görünüyor.
2. IDE'den kaynak kodun ekran görüntülerini kopyalayıp yapıştırın. En azından renkleri koruyorum. Ancak yazı tipi boyutumu değiştirirsem, mahvolurum. Ayrıca sayfa sınırlarını da aştım. Ve itiraf edelim, Word bir belgedeki birden çok görüntüyü yönetmekte pek iyi değil.
3. HTML yazın (burada gerçekten bir seçenek değil)

Bunu yapmanın daha iyi (ve ideal olarak taşınabilir) bir yolu var mı? LaTeX ortamına benzer en azından bir tür sözlü stil var mı? RTF olarak kopyalayıp yapıştırabileceğim en azından güzel bir yazıcı var mı?

Microsoft için ücretsiz çalışmaktan kesinlikle nefret ediyorum ve küçümsüyorum, çünkü onca milyarlarca dolardan sonra HALA lanet web sitelerinde ekran görüntüleriyle böyle şeyler hakkında doğru kılavuzlara sahip değiller.

Her neyse, burada sözdizimi renklendirme için Notepad ++ ve altyazılı bir TextBox kullanan Word 2010'da hızlı bir kılavuz:

1. Ekle / Metin Kutusu / Basit Metin Kutusu'nu seçin
   
2. Varsayılan bir metin kutusu eklenir
   
3. NPP'ye geçin, kodunuzun sözdizimi renklendirmesi için dili seçin, Eklentiler / NPPExport / RTF'yi panoya kopyala'ya gidin
   
4. Kelimeye geri dönün ve metin kutusuna yapıştırın - çok küçük olabilir ...
   
5. ... bu yüzden boyutunu değiştirmeniz gerekebilir
   
6. Metin kutusunu seçtikten sonra üzerine sağ tıklayın, ardından Başlık Ekle ... seçeneğini seçin.
   
7. Başlık menüsünde, henüz etiketiniz yoksa Yeni Etiket'i tıklayın ve yeni etiketi "Kod" olarak ayarlayın, Tamam'ı tıklayın ...
   
8. ... ardından Başlık iletişim kutusunda, etiketi Kod olarak değiştirin ve Tamam'a basın
   
9. Son olarak, yeni oluşturulan başlık kutusuna başlığınızı yazın
   

Geçenlerde bu gönderiye rastladım ve bazı yararlı ipuçları buldum. Ancak, ihtiyaçlarıma uyan tamamen farklı bir yaklaşım kullanmaya başladım. Yaklaşımı ve neden bu yaklaşımı seçtiğime dair gerekçelerimi paylaşıyorum. Gönderi istediğimden daha uzun, ancak ekran görüntülerinin her zaman yardımcı olduğuna inanıyorum. Umarım cevap birisi için yararlı olur.

Gereksinimlerim şunlardı:

1. Daha kolay görünürlük ve kod ile diğer metinlerin farklılaştırılması için sözdizimi vurgulayarak bir word belgesine kod parçacıkları ekleyin.
2. Kod parçacığı, diğer metinle aynı hizada olacaktır.
3. Kod parçacığı, fazladan çaba göstermeden sayfalarda sorunsuz bir şekilde bölünecektir.
4. Kod pasajının güzel bir sınırı olacaktır.
5. Kod parçacığında yazım denetimi devre dışı bırakılacaktır.

Yaklaşımım aşağıda listelendiği gibidir:

1. Yukarıdaki sözdizimi vurgulama gereksinimi 1'i elde etmek için harici aracı kullanın. Yukarıda anlatıldığı gibi notepad plus plus kullanılabilir. Ancak, burada bulunan aracı kullanıyorum - http://www.planetb.ca/syntax-highlight-word . Bu bana satır numarasını kullanma seçeneğinin yanı sıra çok güzel sözdizimi vurgulamasını da veriyor (Lütfen bu adım için Google Chrome'u kullanın, çünkü birkaç kullanıcı yorumunda da belirtildiği gibi Mozilla Firefox kullanılırken sözdizimi vurgusu kopyalanmaz). Sözdizimi vurgulama elde etme adımları aşağıda listelenmiştir:
   • Yukarıda verilen web sitesini Chrome'da açın ve kod parçacığını metin alanına kopyalayın. Bunu göstermek için örnek bir XML kullanacağım (buradan XML örneği - http://www.service-architecture.com/articles/object-oriented-databases/xml_file_for_complex_data.html ).
   • Açılır menüden dili seçin.
   • "Vurgulananları Göster" düğmesini tıklayın. Sözdizimi ile vurgulanmış kod parçacığı, bu durumda seçtiğimiz XML örneğiyle yeni bir sekme açacaktır. Örneğin aşağıdaki resme bakın.
   • Satır numaralarını kapatmak için sayfayı krom olarak inceleyin. Ardından, aşağıdaki resimde gösterildiği gibi, stiller altında, ".dp-highlighter ol" içindeki "margin" özelliğinin seçimini kaldırın. Satır numaralarını saklamak istiyorsanız, sonraki adıma geçin.
   • Sözdizimi vurgulanan kodu seçin ve kopyala'yı tıklayın. Artık kodunuz Microsoft Word'e yapıştırılmaya hazır. Bu bilgileri sağladığınız için bu bloga teşekkür ederiz - http://idratherbewriting.com/2013/04/04/adding-syntax-highlighting-to-code-examples-online-and-in-microsoft-word/ .

2. Yukarıdaki 2., 3. ve 4. gereksinimleri karşılamak için, kod parçacığını eklemek için Microsoft word'deki tabloyu kullanın. Adımlar aşağıda listelenmiştir:

   • Tek sütunlu bir tablo ekleyin.
   • 1. adımdan kopyalanan metni tablo sütununa yapıştırın. Microsoft word ile ne kadar iyi çalıştığını göstermek için satır numaralarını sakladım.
   • İstediğiniz gibi kenarlık uygulayın. Boyut 1pt kullandım. Elde edilen Microsoft kelime pasajı aşağıdaki ekran görüntüsünde gösterildiği gibi görünecektir. Sayfa boyunca ne kadar güzel bir şekilde kırıldığına dikkat edin - "OpenDocument Metni" nesnesi eklerken veya "Basit Metin Kutusu" kullanıyorsanız bunu yönetmek için fazladan çaba gerektirmez.

3. Gereksinim 5'e ulaşmak için aşağıdaki adımları izleyin:

   • Tablonun tamamını veya metni seçin.
   • Gözden Geçir sekmesine gidin. Dil altında, "Yazım Denetleme Dili" ni seçin. Yeni bir pop-up sunulacak.
   • "Yazım veya dilbilgisi denetimi yapma" seçeneğini seçin. Ardından Tamam'ı tıklayın.
   • Ortaya çıkan metin yazım denetimi devre dışı bırakıldı. Nihai sonuç aşağıdaki resimde gösterilmektedir ve tüm gereksinimleri karşılar.

Lütfen herhangi bir geri bildiriminiz veya iyileştirmeniz varsa veya yaklaşımla ilgili herhangi bir sorunla karşılaşırsanız belirtin.

Bir stil tanımlamalısınWord belgenizde ve bunu kaynak kodu için kullanmanız gerekir. Genelde küçük punto boyutunda tek aralıklı yazı tipi, sabit boyutlu sekmeler, tek satır aralığı, paragraf öncesi / sonrası yok vb. Olan "Kod" adında bir stile sahibim. Bu stili yalnızca bir kez tanımlamanız ve sonra yeniden kullanmanız gerekir. Kaynak kodunuzu yapıştırın ve ona "Kod" stilini uygulayın.

Bazı düzenleyicilerin (örneğin Mac’te Xcode) uygulamalar arasında kopyalarken / yapıştırırken panoya RTF’nin yanı sıra metin de eklediğini unutmayın - Word, RTF’yi tanır ve biçimlendirmeyi, söz dizimi rengini vb. Yararlı bir şekilde korur.

Xcode'daki kaynak kodu:

Kopyalandı ve Word'e yapıştırıldı:

(Not: Word'deki "Kod" stilinizde yazım denetimini devre dışı bırakmak iyi bir fikirdir.)

IDE'ye bağlıdır. Örneğin hem Visual Studio hem de Eclipse , tüm biçimlendirmenizi koruyarak RTF olarak kopyalayıp Word'e yapıştırmanıza olanak tanır.

Notepad ++ , RTF'ye kopyalamanıza izin veren "NppExport" (önceden yüklenmiş olarak gelir) adlı bir eklentiye sahiptir, ancak Notepad ++ 'nın sözdizimi vurgulamasını pek umursamıyorum (yine de kesinlikle geçerli olacaktır). Yaptığı şey düzinelerce dili desteklemektir, oysa yukarıda belirtilen IDE'lerin her biri bir avuç ile sınırlıdır (diğer eklentiler olmadan).

Bu, şu yanıtla ilgilidir: https://stackoverflow.com/a/2653406/931265 Bir nesne oluşturmak tüm sorunlarımı çözdü.

Ekle> Nesne> Açık Belge Metni

Bu, bir belge penceresi açar, metninizi yapıştırır, istediğiniz gibi biçimlendirir ve kapatır.

Sonuç bir rakamdır. Nesneye sağ tıklayın ve 'başlık ekle'yi seçin.

Artık çapraz referanslar oluşturabilir, bir şekil tablosu oluşturabilirsiniz.

Mac'te bu çözümü vim ile harika buluyorum:

https://github.com/zerowidth/vim-copy-as-rtf

Bunun için Open Xml Sdk kullanabilirsiniz. Kodunuz renk ve biçimlendirmeyle html olarak varsa. Word belgelerine eklemek için altchunks kullanabilirsiniz. Bu gönderiye bakın OpenXML (* .docx) Belgesine HTML Dizesi Ekleyin Bunun yardımcı olacağını umuyoruz!

Yaptığım bu.

Son sonuçlar:

https://stackoverflow.com/a/25092977/1161594

Eklenti Sözdizimi Vurgulamasını Ms.Word https://store.office.com/syntax-highlighter-WA104315019.aspx?assetid=WA104315019'da kullanabilirsiniz . o adımı takip ediyorum ve işe yarıyor

Hala kod parçacıkları eklemenin basit bir yolunu arıyorsanız.

kolayca [Ekle]> [Nesne]> [Açık Belge Metni] seçeneğine gidebilirsiniz> kodunuzu yapıştırın> Kaydet ve Kapat.

Bunu bir makroya da koyabilir ve kolay erişim çubuğunuza ekleyebilirsiniz.

notlar:

• Bu yalnızca bir kod sayfası alacaktır .
• Kişisel Kod olacak değil edilmesi otomatik olarak düzeltilen .
• Bununla yalnızca çift ​​tıklayarak etkileşime girebilirsiniz .

Word'de, yorumları koddan ayırmak için renk kullanan kodu "Yapıştır Kaynak Biçimlendirmesini Yapıştır" seçeneğini kullanarak yapıştırmak mümkündür. Bununla birlikte, yapıştırılan kodu yeni bir stil oluşturmak için kullanırsanız, Word renk kodlu metni otomatik olarak çıkarır ve bunları siyah olarak değiştirir (veya otomatik varsayılan renk ne olursa olsun). Biçim uygulamak, belge biçimi gereksinimleriyle uyumu sağlamanın en iyi yolu olduğundan, Word, yazılım programlarını belgelemek için pek kullanışlı değildir. Maalesef Open Office'in daha iyi olduğunu hatırlamıyorum. En iyi çözüm, varsayılan basit metin kutusunu kullanmaktır.

Tüm yöntemlerinizi denedim ama benim için işe yaramadı, aslında MS Word Tablolarını kullanarak daha kolay bir yöntem oluşturdum .

Artıları:

1. Daha güzel
2. Yönetmesi daha kolay ve daha tutarlı
3. Sorunlara daha az eğilimli
4. Harici eklentilere veya MS Word mikro kodlamaya gerek yoktur.
5. Basit kullanıcılar (benim gibi ) tarafından idare edilmesi daha kolay .

Eksileri: Birisi benim numaramı geliştirebilse de kod renklendirmesini korumayacak.

Adımlar:

1. Bir 3x3 tablo ekleyin, benim durumumda tablonun toplam genişliğini her zaman boş sayfanın genişliğine eşit yapıyorum ( tablo stilini test etmek için minimum 3 satır ).

2. Görünmez sınırları kullanın (" Kenarlık Yok " seçeneği ) ve " Kılavuz Çizgilerini Görüntüle " seçeneğini etkinleştirin . bu yönü olmalıdır. Tablonun ızgarasını görmeniz için bu satırların sizin için olduğunu ve yazdırılmayacağına dikkat edin.

3. Beğendiğiniz yönü elde etmek için hücrelerin aralığı ve sütun genişliğinde ayarlamalar yapın. ( İnce ayar için " Tablo Özellikleri " bölümüne girmeniz gerekecektir ).

4. Yalnızca kod parçacıkları için " Kod " adıyla bir " Paragraf Stili " oluşturun ( fikir edinmek için https://stackoverflow.com/a/25092977/8533804 adresini kontrol edin , hepsini takip etmek zorunda değilsiniz)

5. Önceden oluşturulmuş stile dayalı olacak " Code_numberline " adıyla başka bir " Paragraf Stili " oluşturun.

6. Yeni oluşturulan " Code_numberline " da beğendiğiniz numaralandırma stilini ekleyin (bu, satır numaralandırmayı otomatik hale getirecektir).

7. İlk sütuna " Code_numberline " ve 3 sütuna " Kod " uygulayın.

8. Orta sütuna bir dolgu ekleyin.

9. Bu masa stilini kaydedin ve keyfini çıkarın!

Bunu kullanın - http://hilite.me/

hilite.me, kod parçacıklarınızı, blog yazılarına, e-postalara ve web sitelerine kolayca yerleştirilebilen güzel yazdırılmış HTML biçimine dönüştürür.

Nasıl: Yalnızca kaynak kodunu sol bölmeye kopyalayın, dili ve renk düzenini seçin ve "Vurgula!" Öğesini tıklayın. Sağ bölmedeki HTML artık blogunuza veya e-postanıza yapıştırılabilir, harici CSS veya Javascript dosyaları gerekmez.

Microsoft Word belgesi için: Önizleme bölümündeki içeriği kopyalayın ve Microsoft Word belgenize yapıştırın.

3 bölüm: Kaynak Kodu, HTML ve Önizleme

Basit kod biçimlendirmesi istiyorsanız kolay bir yol var.

1. Kelime aç> Sekme ekle> "Eklentileri Al" ı tıklayın
2. "İçerik karıştırıcı" için arama yapın 3. "Ekle" ye tıklayın

Ardından içerik karıştırıcı eklentisi otomatik olarak açılır ve kodunuzu kopyalayıp buraya yapıştırabilir ve word doc'a eklemek için "Ekle" yi tıklayabilirsiniz.

Bu yanıtlar, web eklenti çözümüne kıyasla modası geçmiş ve oldukça sıkıcı görünüyor; Office 2013'ten bu yana ürünler için mevcuttur.

Metni yerinde kodlamanıza izin veren Easy Code Formatter kullanıyorum . Ayrıca size satır numaralandırma seçenekleri, vurgulama, farklı stiller sunar ve stiller buradan açık kaynaklıdır: https://github.com/armhil/easy-code-formatter-styles, böylece stili kendiniz genişletebilirsiniz. Yüklemek için - Microsoft Word'ü açın, Sekme Ekle'ye gidin / "Eklentileri Al" ı tıklayın ve "Kolay Kod Biçimlendiricisi" ni arayın