Yorum yöntemleri notating tercih edilen yolu nedir?

4 Cevap php

Bazen bir yorum zaman başka bir yönteme başvurmak zorundadır. İşte PHP bazı örnek:

class A
{
    /**
     * @see B::bar
     */
    public function foo()
    {
        B::bar();
    }
}

class B
{
    public static function bar()
    {
        // ...
    }
}

So what if there would be a non-static method bar in class B? What is the best way to name other methods in comments?

Edit

PHP kılavuzu mysqli->affected_rows kullanmak gibi PDO::beginTransaction gibi görünüyor. Ama bu isimli yöntemin adından sonra parantez dahil değil ne. Yanlısı ve burada aleyhte nedir? Yani bir yöntem parantez tarafından takip oldukça açıktır, bu yüzden neden hayır izni 'em out?

Önceden thx!

4 Cevap

Sen yerine bir sınıf yöntemi daha bir örnek / nesne yöntem başvurmak için -> operatörü kullanabilirsiniz. PHP.net (MySQLi class örneğin bakınız) yanı sıra kendi el kitabında bunu yapıyor.

Ben yazmak istiyorum:

class A {
    // see B::bar()
    public function foo() {
        B::bar();
    }
}

Benim çeşitli değişikliklere ilişkin benim en güçlü düzenlenen görüş sinemaskop yorumlar Şeytan işi olmasıdır. Statik olmayan bir şey vs statik ilgili, ben anlamak ve B::bar() bar() statik olmadığını, konuşma amaçlı fonksiyon tanımına başvurmak için kullanın.

Görüşme B::bar() hiçbir şey yapmadı ama bir fonksiyon A::foo() aslında orada olsaydı, ben yorum dahil olmaz çünkü Yukarıdaki örnekte, yalnızca bilgi amaçlıdır, tabii, çünkü eğer Benim kod okuma kişi ona yardım etmek istemiyorsanız, bir aptal.

Bence, senin örnek yeterlidir. Sen B bakmalıdır :: Bar B :: bar () gibi olsa.

Geri A sınıfı işaret ederek, otomatik olarak B için oluşturulan belgelerde bir @ usedby başvuru yaratacak :: bar () @uses php-doc tag kullanarak düşünebilirsiniz

/**
 * @uses B::bar()
 */

Bildiğim kadarıyla belgeleri ile ilgili olarak, statik olma yöntemi usedby @ @ kullanır ilgili değildir ya da @ sadece statik @, bkz. @ 'De statik gösterimde (in) yöntemi, statik @ göstermek için değil sadece etiket çubuğuna aramak için kapsamını iletişim kurar kullanır.

PhpDocumentor için dokümantasyon gibi bir şey kullanabilirsiniz ima görünüyor

class A
{
  /**
   * @see B
   * @see function bar()
   */
  public function foo()
  {
    // ...
  }
}

Ayrıca, gelen phpDocumentor manual,

@uses is very similar to @see, see the documentation for @see for details on format and structure. The @uses tag differs from @see in two ways. @see is a one-way link, meaning the documentation containing a @see tag contains a link to other documentation. The @uses tag automatically creates a virtual @usedby tag in the other documentation that links to the documentation containing the @uses tag. In other words, it is exactly like @see, except a return link is added automatically.

etiketler