Xcode 8 otomatik oluşturulan hızlı yardım belgeleri


85

Xcode 8'de duyurulan yeni özellikler arasında görebiliyoruz

"Hızlı Yardım belgelerini otomatik oluştur":

görüntü açıklamasını buraya girin

NSHipster'dan bu makalede öğrenebileceğimiz gibi manuel kod belgelerinin sonu bu mu?

Birisi bu yeni özelliğin artılarını ve eksilerini özetleyebilir mi? Jazzy gibi aletlerin yerini alıyor mu ?

Yeni özellik hakkında daha fazla bilgi bulamadım.


@Rob: Xcode 8 bêta'yı kurmadan ve hemen sonra kaldırmadan nasıl göründüğüne dair herhangi bir fikrim var (işimin mac'una yükleme yetkim yok)
H4Hugo

Bazı WWDC 2016 videolarında gösterilmiştir.
Rob


2
Videoda saat 37: 00'de bir demo görebilirsiniz - ancak gerçekten çalışmasını sağlayamıyorum! Swift ve obj-c ile ve seçilen bir fonksiyonun çeşitli farklı kısımlarını denedim.
Şaşkın Vorlon

Yanıtlar:


204

Bu, aşağıdaki gibi bir yöntem seçebileceğiniz Xcode 8 (ve sonrası) özelliğini ifade eder:

func foo(bar: Int) -> String { ... }

... ve sonra + option+ tuşlarına basın /(veya Xcode'un "Düzenleyici" menüsünden "Yapı" »" Belge ekle "yi seçin) ve sizin için aşağıdaki yorum şablonunu oluşturacaktır:

/// <#Description#>
///
/// - parameter bar: <#bar description#>
///
/// - returns: <#return value description#>

Sadece Hızlı Yardım için belgelerin yazılmasını kolaylaştırır.


Unutmayın, bu davranış zaman içinde biraz değişmiş olsa da, Xcode bunu yapmaya çalıştığınızda imlecin nerede olması gerektiği konusunda özel olabilir. Örneğin, yukarıdaki örneğimde, bunun çalışması için imlecin işlev adında bir yerde olması gerekir foo. Veya işlev adına çift tıklayın ve ardından + option+/


1
onu çalıştırabilir misin? Yapamam. Yapabilirsen; komutu kullandığınızda neyi seçiyorsunuz? Hemen hemen her seçeneği denedim ...
Confused Vorlon

2
İmlecimi yöntem adında bir yere koydum ve ardından Xcode 8'de command + option + "/" tuşlarına bastım (hem de "Düzenleyici" - "Yapı" - "Belge ekle" yi seçtim) ve iyi çalışıyor. Şimdiye kadar karşılaştığım tek sorun, @IBActionyöntemlerle karıştırılmış gibi görünmesi . Ancak hem Objective-C hem de Swift fine ile çalışır. Hala sorun yaşıyorsanız ve Xcode'u yeniden başlatma ve / veya makinenizi yeniden başlatma gibi olağan lame prosedürünü denediyseniz, bu beta yazılımı hakkında bir hata raporu göndermek isteyebilirsiniz.
Rob

2
Yeniden başlatmayı denedim ama yine de neşe yok. Bir hata raporu gönderdim.
Kafası Karışık Vorlon

5
Aslında Xcode 8 beta 1'den itibaren çalışıyor, ancak El Capitan'ı kullanıyorsanız, Xcode'u başlatmanız, gerekli sistem bileşenlerini kurmasına izin vermeniz ve ardından sudo /usr/libexec/xpccachectlTerminal'de çalıştırmanız ve Mac'inizi ondan veya başka herhangi bir Xcode Uzantısından önce yeniden başlatmanız gerekir. iş. Xcode 8 sürüm notlarına bakın.
Chris Hanson

1
Düzensiz çalıştığını görüyorum. Bazen harika çalışır ve diğer zamanlarda hiç işe yaramaz. Ben de nedenini keşfetmedim. Açıkçası, işe yaradığında, otomatik olarak ürettiği şeyleri oldukça seyrek buluyorum (Açıklamadaki yöntem adı?). Sizin için sorunsuz çalışıyor, harika. Bazılarımız için ara sıra ya da işe yaramıyor.
Lloyd Sargent

7

Bu, büyük olasılıkla, klavyenizin elde etmek için shift tuşuna basmanız gerekiyorsa, '/' ile TÜM kısayol tuşlarının mevcut XCode 8 yapısında çalışmaması gerçeğiyle ilgilidir.

Yani, almanca klavyede '/' shift + 7'dir, alt + cmd + shift-7 tuşlarına basmak bir şey yapmaz. İe cmd + shift + opt + d atarsanız, gayet iyi çalışır.

Maalesef şu anda da çalışmayan '///' kısayolu, muhtemelen tam olarak bu kısayolu kullanan eski XCode eklentisi VVDocumenter'dan kaynaklanıyor.

Harika bir özellik, Apple tarafında kötü QA.


Xcode 8 beta'da bu hata vardı, ancak yayınlanan sürümde düzeltildi.
Eric Aya

8A218a yayınlanan sürümdür - ve yorum kısayolu benim için tekrar çalışıyor (betalarda yoktu).
Eric Aya

Shift kullanmadan "/" elde ettiğiniz bir klavye düzeninde misiniz?
Klaus Busse

Evet, iki klavyem var, bir Fransız Azerty'si ":" üzerinde "/" ve Amerikan Qwerty'si. Her ikisi de yorum kısayolu için iyi çalışıyor.
Eric Aya

Benim için aralıklı (Amerikan klavyesi).
Lloyd Sargent
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.